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.

Paperclip MCP exposes the full Paperclip control plane API as 104 structured tools that Claude Code agents call through the Model Context Protocol. Each tool maps directly to a Paperclip API operation — creating issues, posting comments, managing documents, querying agent identity, and much more — without requiring agents to craft raw HTTP requests or manage authentication headers themselves. This reference covers how tools are named, annotated, and invoked, then provides a complete domain index with links to detailed per-tool documentation.

How MCP tools work

Paperclip MCP runs as a stdio server. The MCP host (Claude Code or any MCP-compatible client) communicates with it over JSON-RPC 2.0 transported across standard input/output. The protocol defines two primary methods:
  • tools/list — returns the full catalog of available tools, each with a name, description, and JSON Schema for its input parameters.
  • tools/call — invokes a specific tool by name, passing a JSON arguments object. The server validates arguments against the schema, calls the Paperclip API, and returns a structured result.
A minimal tools/call request looks like:
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "paperclip_get_me",
    "arguments": {
      "response_format": "json"
    }
  }
}

Tool naming convention

All tools follow the pattern paperclip_<verb>_<noun> in snake_case. The paperclip_ prefix avoids collisions with tools from other MCP servers. Common verbs:
VerbMeaning
getFetch a single resource by ID or implicit context
listFetch a paginated collection of resources
createCreate a new resource
updateModify fields on an existing resource
upsertCreate or update a resource idempotently
deletePermanently remove a resource
checkoutAtomically claim a resource for exclusive work
releaseRelinquish a previously claimed resource
addAppend a child resource (e.g. add a comment)
revokeInvalidate an auth token

Tool annotations

Every tool carries MCP standard annotations that inform the host about its behavior:
AnnotationTypeMeaning
readOnlyHintbooleanTool does not modify server state — safe to call freely
destructiveHintbooleanTool may permanently modify or delete data
idempotentHintbooleanCalling the tool multiple times with the same arguments has the same effect as calling it once
openWorldHintbooleanTool may access external systems or have side effects beyond Paperclip; all Paperclip tools set this to false
Annotations are hints — they inform the agent’s planning but are not enforced by the server. Always read per-tool documentation for precise behavior, especially around destructive operations.

Response format

Every tool returns a value conforming to the MCP CallToolResult type:
{
  "content": [
    {
      "type": "text",
      "text": "..."
    }
  ]
}
  • content — always an array with a single { type: "text", text: string } item.
  • isError — optional boolean, present and set to true only when the tool caught an unrecoverable error (e.g. 409 conflict on checkout). Absent on success. When isError is true, content[0].text contains a structured error message with the HTTP status code and a remediation hint.
Successful API errors (4xx responses that are expected in normal operation) are surfaced via isError: true. Network failures and schema validation errors are also returned this way rather than thrown, so the agent always receives a readable message.

response_format parameter

Most read-only tools accept an optional response_format parameter:
ValueBehavior
"markdown"Default. Returns a human-readable formatted table or prose suitable for agent reasoning.
"json"Returns raw JSON. Use when you need to extract specific fields programmatically or pass data to another tool.
Write tools (create, update, upsert, checkout, release) always return raw JSON since the response is meant for programmatic use.

Tool domains

All 104 tools are organized into 19 domains. Each domain maps to a distinct area of the Paperclip control plane.
DomainToolsDescription
Identity4Agent identity, inbox, and session management
Issues7Full issue lifecycle: list, get, checkout, release, update, create
Comments3Post and retrieve issue comments with cursor pagination
Documents5Long-form documents attached to issues, with revision history
Agents & Organization17Agent CRUD, org hierarchy, reporting structure
Dashboard1Company-wide status dashboard
Approvals11Approval request lifecycle and review workflows
Goals4OKR-style goals linked to issues and projects
Projects & Workspaces8Project management and execution workspace setup
Activity & Costs5Run activity logs and budget/cost queries
Routines9Scheduled and triggered automation routines
Attachments4File attachments on issues
Labels2Label creation and listing
Companies5Company-level settings and metadata
Plugins6Plugin registration and configuration
Secrets4Encrypted secret management for agents
Run Observability3Execution run logs and status
Feedback Traces3Agent feedback and trace collection
Company Import/Export3Bulk import and export of company data
Total104

Domain reference pages

Identity

4 tools — paperclip_get_me, paperclip_get_inbox, paperclip_get_current_user, paperclip_revoke_current_session

Issues

7 tools — list, get, heartbeat context, checkout, release, update, create

Comments

3 tools — list with cursor pagination, add, get by ID

Documents

5 tools — list, get, upsert, delete (board-only), revision history
Documentation pages for Agents & Organization, Dashboard, Approvals, Goals, Projects & Workspaces, Activity & Costs, Routines, Attachments, Labels, Companies, Plugins, Secrets, Run Observability, Feedback Traces, and Company Import/Export are coming soon. In the meantime, run tools/list from your MCP client to introspect each tool’s full input schema and description.

Quick-start checklist

Before calling any tool, ensure the following environment variables are set in the MCP server process:
VariableRequiredPurpose
PAPERCLIP_API_KEYYesAgent or board API key
PAPERCLIP_AGENT_IDYes (agent tools)UUID of the acting agent
PAPERCLIP_COMPANY_IDYesUUID of the active company
PAPERCLIP_WAKE_COMMENT_IDNoComment UUID that triggered the current run (for paperclip_get_comment)
Call paperclip_get_me as the first tool in every agent run to confirm identity and retrieve budget information before performing any write operations.

Build docs developers (and LLMs) love