> ## 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.

# Agent quickstart

> For coding agents: connect yourself to OpenScaffold. A person sent you here.

You are an agent. A person asked you to connect to OpenScaffold, which holds their customer deployments: each customer's cited plan, rules, people and everything the customer said. Connect yourself with the steps below.

**Do:** run the commands yourself. Stop and tell the person exactly what to do when a step needs their browser, then wait for them to confirm.
**Do not:** approve a sign-in on their behalf, create an account, edit credential files by hand, or connect to anything other than `https://app.openscaffold.ai/api/mcp/mcp`.

The server signs in with OAuth. The first time, a browser page opens: the person signs in, picks their workspace and clicks **Allow**. You only ever see that one workspace.

## 1. Connect, for the agent you are

**Codex**

1. Run `codex mcp add openscaffold --url https://app.openscaffold.ai/api/mcp/mcp`
2. Run `codex mcp login openscaffold`. Tell the person to approve in the browser that opens; wait for the command to finish.
3. Tell the person to start a new Codex task (tools load at the start of a task), then continue from step 2 there.

**Claude Code**

1. Run `claude plugin install openscaffold --marketplace Sigma-M-A/openscaffold-plugin`
2. Tell the person to restart Claude Code, run `/mcp`, pick **openscaffold** and **Authenticate**, then approve in the browser.
3. Optional, so sessions start with the customer loaded when it can be matched (a recent Start coding, the repo and branch used before, or the only deployment): run `npx -y @openscaffold/cli@latest login` and tell the person to approve it in the browser. When nothing matches, call `use_deployment` for the customer they name.

**Cursor**

1. Add this under `mcpServers` in `~/.cursor/mcp.json`. Create the file if it's missing; keep any servers already there.
   ```json theme={null}
   "openscaffold": { "url": "https://app.openscaffold.ai/api/mcp/mcp" }
   ```
2. Tell the person to open **Cursor Settings → MCP**, check **openscaffold** is on, and sign in from there.

**VS Code**

1. Run `code --add-mcp '{"name":"openscaffold","type":"http","url":"https://app.openscaffold.ai/api/mcp/mcp"}'`
2. Tell the person to start the server from the MCP view and approve the sign-in.

**Anything else** (Windsurf, Cline, Zed, other MCP clients): add a remote HTTP MCP server named `openscaffold` with the URL `https://app.openscaffold.ai/api/mcp/mcp` in your client's MCP config, then have the person sign in when your client prompts.

## 2. Test the connection

Call the openscaffold `list_deployments` tool. Show the person the deployments it returns and say which tool you called. If the tool isn't available, the tools haven't loaded yet: ask the person to restart or start a new task, then try again.

## 3. Then

Tell the person they're connected. To work on a customer, call `use_deployment` with its name; follow the briefing it returns. Search the customer's material before assuming any requirement.


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