> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openscaffold.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect your coding agent

> Connect your coding agent to OpenScaffold: one MCP server, signed in with your browser.

Every agent connects to the same OpenScaffold MCP server, `https://app.openscaffold.ai/api/mcp/mcp`. The first time it uses OpenScaffold it opens your browser: sign in, pick your workspace, click **Allow**. It only ever sees that one workspace.

## Let your agent set it up

Paste this into Claude Code, Cursor, Codex or any coding agent:

```text Prompt theme={null}
Use curl to read https://docs.openscaffold.ai/agent-quickstart.md and connect yourself to OpenScaffold. Stop and tell me when I need to approve a sign-in in my browser.
```

It connects itself, asks you to approve the sign-in, then lists your deployments to prove it works.

## Or set it up yourself

**Claude Code**

```bash theme={null}
claude plugin install openscaffold --marketplace Sigma-M-A/openscaffold-plugin
```

Restart Claude Code, run `/mcp`, pick **openscaffold** and **Authenticate**. The plugin also adds `/openscaffold:requirements`, `/openscaffold:what-changed`, `/openscaffold:check-plan` and `/openscaffold:demo-check`.

To have sessions start with the right customer already loaded, also run once (it picks the customer from a recent **Start coding**, the repo and branch you worked in before, or your only deployment; otherwise the agent asks you which one):

```bash theme={null}
npx @openscaffold/cli@latest login
```

**Cursor**

[Add to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=openscaffold\&config=eyJ1cmwiOiJodHRwczovL2FwcC5vcGVuc2NhZmZvbGQuYWkvYXBpL21jcC9tY3AifQ%3D%3D), or add it to `~/.cursor/mcp.json`:

```json theme={null}
{
  "mcpServers": {
    "openscaffold": { "url": "https://app.openscaffold.ai/api/mcp/mcp" }
  }
}
```

Then sign in from **Cursor Settings → MCP**.

**Codex**

```bash theme={null}
codex mcp add openscaffold --url https://app.openscaffold.ai/api/mcp/mcp
codex mcp login openscaffold
```

Start a new Codex task so the tools load. Or in `~/.codex/config.toml`:

```toml theme={null}
[mcp_servers.openscaffold]
url = "https://app.openscaffold.ai/api/mcp/mcp"
```

**VS Code**

```bash theme={null}
code --add-mcp '{"name":"openscaffold","type":"http","url":"https://app.openscaffold.ai/api/mcp/mcp"}'
```

Start the server from the MCP view and approve the sign-in.

**Other clients**

Windsurf, Cline, Zed and other MCP clients: add a remote HTTP server named `openscaffold` with the URL `https://app.openscaffold.ai/api/mcp/mcp`, then sign in when your client prompts. Most take this shape:

```json theme={null}
{ "openscaffold": { "type": "http", "url": "https://app.openscaffold.ai/api/mcp/mcp" } }
```

## Test the connection

Ask your agent:

```text Prompt theme={null}
List my OpenScaffold deployments and tell me which OpenScaffold tool you used.
```

It should call `list_deployments` and show your customers. Then try "Load the \<customer> deployment and show me the briefing."

## Troubleshooting

| What you see | Fix |
| - | - |
| The OpenScaffold tools don't show up | Tools load when a session starts. Restart the agent, or start a new task in Codex. |
| Sign-in keeps looping or says "can't connect" | Start the sign-in from the agent itself, not from an old browser tab. OpenScaffold only connects agents running on your machine. |
| "No active deployment" | Ask the agent to call `list_deployments` and pick an active one; the deployment may be archived, or the name or id wrong. Only if the customer you want isn't listed at all is the agent in the wrong workspace: disconnect it in Settings → Connected agents, sign in again and pick the right one. |
| The agent answers without using OpenScaffold | Name it: "Use OpenScaffold to…". Or load the customer first with "Load the \<customer> deployment". |

## What your agent can see

* **One workspace:** the one you picked when you signed in. If you leave the workspace, the agent loses access within 60 seconds.
* **Disconnect anytime:** Settings → Connected agents. It loses access within 60 seconds.
* **Keep tool approvals on:** your agent asks before calling tools that change things, such as proposing a plan change. OpenScaffold never applies a change by itself; you approve every one.

To set up your first deployment once connected, see [Onboard with your agent](https://docs.openscaffold.ai/agent-onboarding.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.