Docs Navigation
MCP Server
ForgeOS exposes 21 governance tools over the Model Context Protocol (MCP). Any MCP-compatible agent — Claude, GPT-4, Gemini, local models — can call gate-check, submit reviews, and query institutional knowledge without custom integration. Your AI provides the intelligence — ForgeOS provides the governance. Connect via MCP with your ForgeOS API key. Raw source code stays local — only project metadata (file structure, languages, dependencies) is sent to ForgeOS.
Installation
Install globally:
npm install -g @synctek/forgeosOr use npx for zero-install (recommended):
npx -y @synctek/forgeos@latestConfiguration
The ForgeOS MCP server runs via stdio using npx. The config block is the same across editors — only the outer key differs.
{ "mcpServers": { "forgeos": { "command": "npx", "args": ["-y", "@synctek/forgeos@latest"], "env": { "FORGEOS_ENGINE_URL": "https://forgeos-api.synctek.io", "FORGEOS_API_KEY": "fos_your_api_key_here" } } }}Note:
FORGEOS_API_KEYis your ForgeOS API key. Get it from the ForgeOS dashboard after registering. TheFORGEOS_ENGINE_URLandFORGEOS_API_KEYenv vars are read directly by the MCP server (distinct from theX-ForgeOS-API-KeyHTTP header used by direct REST calls).
- Cursor — add to
.cursor/mcp.json(project root or global Cursor settings) using the"mcpServers"key as shown above - Claude Code — add to
~/.claude/settings.jsonusing the"mcpServers"key as shown above - VS Code (Copilot) — add to
settings.jsonusing"mcp": { "servers": { ... } }instead of"mcpServers"
HTTP/SSE transport
For hosted agents and cloud workflows, connect directly via HTTP/SSE:
Endpoint: https://mcp.synctek.io/mcpHeader: X-ForgeOS-API-Key: fos_your_api_key_hereNo installation required — ideal for server-side agents, CI pipelines, and any environment where running a local process is not practical.
Tools reference
ForgeOS provides 21 MCP tools organized by workflow stage.
Session
forge_init
Initialize a ForgeOS governance session. Returns project state, active work, governance rules, and workflow runbook. Call this on every session start.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID to initialize |
developer_id | string | No | Developer identifier (default: local) |
forge_create_project
Create a new ForgeOS project. Projects are the top-level container for initiatives, changesets, and governance workflows.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Project name |
description | string | No | Project description |
platform | string | No | Target platform: web, mobile, api, cli, desktop, or other |
Initiative management
forge_create_initiative
Create a new initiative to track a piece of work. Returns the initiative with a generated ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
title | string | Yes | Initiative title |
description | string | Yes | What this initiative accomplishes |
priority | string | No | low, medium, high, or critical |
forge_get_workflow
Get the current workflow state for an initiative. Shows which step the developer is on, what is needed next, and overall progress.
| Parameter | Type | Required | Description |
|---|---|---|---|
initiative_id | string | Yes | Initiative ID |
Changeset lifecycle
forge_propose_changeset
Propose a changeset for an initiative. The engine computes a risk score and determines required gates, roles, and evidence. Returns the changeset with its risk profile and gate pipeline.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
initiative_id | string | Yes | Initiative this changeset belongs to |
description | string | Yes | What changed and why |
files_changed | string[] | Yes | File paths that changed |
modules_affected | string[] | Yes | Module/area names affected |
branch | string | No | Git branch name |
forge_submit_evidence
Submit evidence (test results, scan outputs, etc.) for a changeset. Auto-populates gate evidence requirements.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID |
type | string | Yes | unit_test, coverage, lint, security_scan, benchmark, migration_plan, ux_snapshot, a11y_audit, or ai_review |
summary | string | Yes | Summary of the evidence |
file_refs | string[] | No | File references |
Review
forge_get_profile
Fetch a reviewer persona profile for local subagent injection. If project context is provided, the profile is enriched with Shared Mind patterns. Use the returned system_prompt as the subagent’s instructions.
| Parameter | Type | Required | Description |
|---|---|---|---|
role | string | Yes | architect, qa_test, security, performance, reliability, accessibility, or docs_release |
project_id | string | No | Project ID for contextualization |
team_id | string | No | Team ID for Shared Mind context (default: default) |
modules_affected | string[] | No | Modules to focus on |
files_changed | string[] | No | Files to focus on |
forge_submit_review
Submit a complete review with findings and verdict. Creates and finalizes the review in one call.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID |
role | string | Yes | Review role (e.g., security, architect) |
status | string | Yes | approved, blocked, or pending |
notes | string | Yes | Review summary |
findings | object[] | Yes | Structured findings (each with category, severity, observation, and optional recommendation) |
Finding severity values: pass, warning, concern, fail.
Gates
forge_check_gates
Get the gate pipeline status for a changeset. Shows which gates are passed, pending, or failed, and what is needed to advance.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID |
forge_promote_gate
Promote a gate to passed status. Requirements (evidence and roles) must be met. Advances the pipeline to the next gate.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID |
gate_id | string | Yes | intent, design, implementation, verification, hardening, or release |
promoted_by | string | No | Who is promoting (default: local_agent) |
forge_release_check
Check if a changeset is ready to release. Returns can_release status and any remaining blockers.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID |
Shared Mind
forge_query_mind
Search the Shared Mind for institutional knowledge. Returns patterns, anti-patterns, and lessons relevant to the context.
| Parameter | Type | Required | Description |
|---|---|---|---|
context | string | Yes | Search context (keywords, module names, etc.) |
team_id | string | No | Team ID (default: default) |
domain | string | No | Specific domain to search |
forge_observe
Record an observation to the Shared Mind. Use when you discover patterns, anti-patterns, or lessons during development.
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Knowledge domain (e.g., module name, technology) |
observation_type | string | Yes | pattern, anti-pattern, fix-recipe, architecture-decision, or lesson |
content | string | Yes | What was observed |
team_id | string | No | Team ID (default: default) |
confidence | number | No | Confidence 0.0-1.0 (default: 0.8) |
tags | string[] | No | Tags for categorization |
Setup and discovery
forge_quickstart
Create a sandbox project and run a complete governance cycle in seconds. Perfect for first-time setup and testing. Returns the full report including project, initiative, changeset, gates, and next steps. Takes no parameters.
forge_scorecard
Check your ForgeOS setup completeness. Shows which onboarding steps are done and what to do next. Use this to verify your environment is fully configured. Takes no parameters.
forge_discover
Analyze your repository and get a recommended governance configuration based on your tech stack. Returns recommended preset, template, evidence mapping, and CI hints.
| Parameter | Type | Required | Description |
|---|---|---|---|
languages | string[] | No | Programming languages detected (e.g. ["typescript", "python"]) |
ci_tools | string[] | No | CI/CD tools in use (e.g. ["github-actions"]) |
test_frameworks | string[] | No | Testing frameworks detected |
team_size | number | No | Approximate team headcount |
repo_type | string | No | Type of repository: monorepo, service, library, mobile-app |
forge_get_presets
List available governance presets (Startup, Enterprise, Regulated, Mobile Release QA). Returns all presets with descriptions so you can choose the right gate template. Takes no parameters.
forge_configure_project_gates
Configure the governance gate template for a project using a preset or custom template.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
preset | string | No | Preset name: startup, enterprise, regulated, mobile_release_qa |
custom_template | object | No | Custom gate template object |
preset and custom_template are mutually exclusive.
forge_recommend_gates
Get a gate recommendation for a changeset based on risk analysis. Returns risk analysis, recommended gates, minimum gates, and rationale.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID to analyse |
forge_workflow_template
Get copy-paste workflow templates for common scenarios (bugfix, feature, hotfix, release candidate).
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | No | Template: bugfix, feature, hotfix, release_candidate. Omit to list all. |
forge_get_context
Get comprehensive context for a changeset including SharedMind patterns, quality warnings, past regressions, and relevant lessons. Call this before submitting evidence or reviews to make informed decisions.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID |
changeset_id | string | Yes | Changeset ID |
Typical workflow
# First time: set up your projectforge_scorecard() → setup completeness checkforge_discover(languages, ci_tools, …) → recommended presetforge_create_project(name, description, platform) → project createdforge_configure_project_gates(project_id, preset) → gate template applied
# Each feature or fixforge_init(project_id) → session context + SharedMind stateforge_create_initiative(project_id, title, …) → initiative createdforge_propose_changeset(project_id, …) → risk score, gate pipelineforge_recommend_gates(project_id, cs_id) → gate recommendationforge_get_context(project_id, cs_id) → SharedMind patterns + past lessonsforge_submit_evidence(project_id, cs_id, …) → evidence attachedforge_get_profile(role="security") → reviewer prompt (enriched by SharedMind)forge_submit_review(project_id, cs_id, …) → review recordedforge_check_gates(project_id, cs_id) → gate statusforge_promote_gate(project_id, cs_id, gate_id) → gate advancedforge_release_check(project_id, cs_id) → ready to shipNext steps
- Authentication — API key management and security
- REST API — Full HTTP endpoint reference for direct integration