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.

Claude Code has first-class MCP support: you can register Paperclip MCP in seconds with a single claude mcp add command, or drop a JSON block directly into settings.json if you prefer manual control. Both approaches result in the same 104 tools being available to every Claude Code session that picks up the config — whether you scope it to a single project or set it globally for your user.

Environment variables

All six variables are read at server startup. The four marked Yes are required — the server exits immediately if any are missing.
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)

Option A — CLI (claude mcp add)

The fastest path. Run one command and Claude Code writes the config entry for you.
1

Open a terminal

Make sure claude is on your PATH. You can verify with claude --version.
2

Run the add command for your preferred variant

3

Verify

Restart Claude Code or run /mcp to reload servers, then ask: “What paperclip tools do you have?” Expect 104 tools listed.

Option B — settings.json

Manually edit the settings file to add or update the paperclip entry under mcpServers. Create the file if it does not exist.

Config file scope

ScopePath
Global (all projects)~/.claude/settings.json
Project (version-controlled).claude/settings.json in your project root
Use the project-scoped file to commit the config alongside your code so your whole team picks it up automatically. Use the global file for personal or cross-project setups.

Config blocks

For Paperclip-orchestrated heartbeat runs, PAPERCLIP_RUN_ID is injected automatically into the process environment — you do not need to add it to settings.json.

Verification

1

Restart Claude Code or reload MCP servers

Run /mcp inside a Claude Code session to reload all configured servers without a full restart.
2

Confirm tool count

Ask Claude: “What paperclip tools do you have?”You should see 104 tools listed. If the count is lower or the server does not appear at all, check the troubleshooting guide.

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