Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/bruhsb/paperclip-mcp/llms.txt

Use this file to discover all available pages before exploring further.

VS Code supports MCP servers through GitHub Copilot and other MCP-capable extensions. You can register Paperclip MCP at the workspace level — committing the config to source control so every contributor gets it automatically — or at the user level to share it across all projects on your machine. VS Code uses a slightly different config key format from Cursor, so make sure you follow the blocks below exactly for your target scope.

Config file location

ScopePath
Workspace.vscode/mcp.json in your project root (recommended for teams)
User (global)User settings.json under the mcp.servers key
Commit .vscode/mcp.json to source control. All contributors automatically get the Paperclip MCP server without any per-machine setup.

Environment variables

VariableRequiredDescription
PAPERCLIP_API_KEYYesBearer token for API authentication
PAPERCLIP_API_URLYesBase URL of the Paperclip API, e.g. http://127.0.0.1:3100
PAPERCLIP_AGENT_IDYesUUID of the agent running this MCP server
PAPERCLIP_COMPANY_IDYesUUID of the company (used for company-scoped endpoints)
PAPERCLIP_RUN_IDNoHeartbeat run ID — injected automatically by Paperclip during agent runs
PAPERCLIP_REQUEST_TIMEOUT_MSNoHTTP request timeout in milliseconds (default: 30000)

Configuration — .vscode/mcp.json

Create or edit .vscode/mcp.json in your project root. Note that the VS Code workspace format uses a top-level servers key (not mcpServers) and requires a "type": "stdio" field.

Configuration — user settings.json

To register the server globally for all projects, open User Settings JSON (Ctrl+Shift+POpen User Settings (JSON)) and add the mcp.servers key. The "type": "stdio" field is still required.

Reload and verify

1

Reload the MCP server

Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run MCP: Restart Server. Alternatively, restart VS Code entirely.
2

Open Copilot Chat and confirm tool count

Open a Copilot Chat panel and ask: “What paperclip tools do you have?”You should see 104 tools listed. If the count is lower or the server does not appear, check the troubleshooting guide.
For Paperclip-orchestrated heartbeat runs, PAPERCLIP_RUN_ID is injected automatically into the process environment — you do not need to add it to the config file.

See also

  • Troubleshooting — server not connecting, auth errors, network issues
  • Auth keys — how to obtain and rotate your PAPERCLIP_API_KEY
  • Docker / Podman guide — building and running the container image locally

Build docs developers (and LLMs) love