MCP server

Proctor includes a local Model Context Protocol server for any compatible AI client—not just Claude. It is docs-first and read-only: clients can search and read the customer documentation and inspect the live OpenAPI schema without receiving candidate data or mutation tools.

What it exposes

• search_docs searches every canonical customer page and returns ranked snippets plus their resource URIs.
• read_doc returns the complete Markdown page for a proctor://docs/<id> URI. This keeps full-page reading available in clients that do not expose MCP resources in their interface.
• Docs resources expose the same pages directly under proctor://docs/<id> for clients with MCP resource support.
• read_openapi and the proctor://openapi resource read the live API schema. If the API is offline, both return a diagnostic message instead of taking down the docs server.

Availability today

The MCP package is currently private and the hosted HTTP endpoint has not shipped. Each developer therefore needs the Proctor repository, Node 20+, pnpm 9+, installed dependencies, and a built MCP package.

Prepare the local server

Run this once from the Proctor repository:

cd /absolute/path/to/proctoring
pnpm install
pnpm --filter @a4anthony/proctorkit-mcp build

Every client below launches the same stdio command. Replace the placeholder with the repository's absolute path:

pnpm --dir /absolute/path/to/proctoring mcp:start

Connect your MCP client

Codex

Codex CLI, the Codex IDE extension, and the ChatGPT desktop app share MCP configuration on the same host. Add the local server from a terminal:

codex mcp add proctor-docs -- \
  pnpm --dir /absolute/path/to/proctoring mcp:start

codex mcp list

Or add it to ~/.codex/config.toml for your user, or .codex/config.toml for a trusted project:

[mcp_servers.proctor_docs]
command = "pnpm"
args = [
  "--dir",
  "/absolute/path/to/proctoring",
  "mcp:start"
]

In the desktop app or IDE extension, you can instead open MCP servers from settings, choose STDIO, and enter the same command and arguments. Restart the client after saving.

Claude Code

claude mcp add --transport stdio proctor-docs -- \
  pnpm --dir /absolute/path/to/proctoring mcp:start

claude mcp list

For project-scoped setup, create .mcp.json:

{
  "mcpServers": {
    "proctor-docs": {
      "command": "pnpm",
      "args": [
        "--dir",
        "/absolute/path/to/proctoring",
        "mcp:start"
      ]
    }
  }
}

Cursor

Create .cursor/mcp.json in a project, or ~/.cursor/mcp.json for all projects:

{
  "mcpServers": {
    "proctor-docs": {
      "command": "pnpm",
      "args": [
        "--dir",
        "/absolute/path/to/proctoring",
        "mcp:start"
      ]
    }
  }
}

Restart or refresh MCP servers in Cursor, then verify with cursor-agent mcp list. Cursor can use the three read-only tools even when its UI does not offer direct resource attachment.

VS Code

Run MCP: Add Server from the Command Palette, or create .vscode/mcp.json:

{
  "servers": {
    "proctorDocs": {
      "type": "stdio",
      "command": "pnpm",
      "args": [
        "--dir",
        "/absolute/path/to/proctoring",
        "mcp:start"
      ]
    }
  }
}

Use MCP: List Servers to start, stop, restart, or inspect output. VS Code also exposes resources through MCP: Browse Resources and Add Context → MCP Resources.

Other MCP clients

Use the client's local/stdio server form with these values:

Using the server

Tool invocation is portable across clients. Ask the agent to search, read the selected full page, and inspect OpenAPI when needed:

Use proctor-docs to search for the webcam policy.
Read the complete proctor://docs/policy page.
Read the live Proctor OpenAPI schema and find the retake endpoint.

Clients with resource support can also open these URIs directly:

proctor://docs/quickstart
proctor://docs/webhooks
proctor://openapi

Claude Code additionally supports its own @proctor-docs:proctor://… reference syntax. That syntax is Claude-specific; use read_doc in clients that do not expose resources.

Troubleshooting

• Server does not start: verify the absolute repository path, Node 20+, pnpm 9+, installed dependencies, and a successful MCP package build.
• OpenAPI is unavailable: start the Proctor API on localhost:3001, or pass PROCTOR_API_URL in the MCP server's environment configuration.
• Tools are stale after an upgrade: restart the MCP server/client so it rediscovers search_docs, read_doc, and read_openapi.
• Resources are not visible: use the equivalent read tools. Resource presentation is a client feature; it is not required for full documentation access.

Hosted endpoint — 🚧 in progress

When shipped, the hosted transport will remove the local repository and build prerequisites. This page will publish the real endpoint, authentication flow, supported scopes, and client-specific HTTP examples only after they are operational.

Safety posture