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.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.
Config file location
| Scope | Path |
|---|---|
| Workspace | .vscode/mcp.json in your project root (recommended for teams) |
| User (global) | User settings.json under the mcp.servers key |
Environment variables
| Variable | Required | Description |
|---|---|---|
PAPERCLIP_API_KEY | Yes | Bearer token for API authentication |
PAPERCLIP_API_URL | Yes | Base URL of the Paperclip API, e.g. http://127.0.0.1:3100 |
PAPERCLIP_AGENT_ID | Yes | UUID of the agent running this MCP server |
PAPERCLIP_COMPANY_ID | Yes | UUID of the company (used for company-scoped endpoints) |
PAPERCLIP_RUN_ID | No | Heartbeat run ID — injected automatically by Paperclip during agent runs |
PAPERCLIP_REQUEST_TIMEOUT_MS | No | HTTP 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.
- npm (recommended)
- Docker / Podman
Requires Node.js ≥ 22 on the host.
Configuration — user settings.json
To register the server globally for all projects, open User Settings JSON (Ctrl+Shift+P → Open User Settings (JSON)) and add the mcp.servers key. The "type": "stdio" field is still required.
- npm (recommended)
- Docker / Podman
Reload and verify
Reload the MCP server
Open the Command Palette (
Ctrl+Shift+P / Cmd+Shift+P) and run MCP: Restart Server. Alternatively, restart VS Code entirely.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