Documentation

Everything you need to integrate

The API is small on purpose, so the docs are short. Start with a key, read a project’s schedule and materials, and subscribe to changes. Every link below points to live reference, not a placeholder.

Getting started

From a key to your first response.

Authentication and scopes

Bearer keys, bound to one organisation.

Reading a job

Projects, schedule and materials.

Webhooks

React when a job moves. In beta.

Agent access

Use Paperless from your AI agent (MCP)

Connect Claude Desktop, Claude Code or Cursor to your jobs. The Paperless MCP server runs on your own computer and gives your agent tools to read projects, the schedule, site diary, variations, defects, documents, materials, contacts and leads, using an API key you control.

  1. 1. Turn on agent access

    Your organisation needs the Agent access add-on.

  2. 2. Create a key

    In Paperless, go to Settings > Developer. Tick only the scopes the agent needs.

  3. 3. Add the server

    On Claude Desktop, download the bundle below and double-click it. For Claude Code or Cursor, use the snippets below. Needs Node.js 20.

Claude Desktop, one click

Download the bundle and double-click it. Claude Desktop installs the server and asks for your API key, storing it in your keychain. No config file to edit and no Node.js install.

Download build-paperless.mcpb

Claude Code

read -rs PAPERLESS_API_KEY && export PAPERLESS_API_KEY
claude mcp add paperless -e PAPERLESS_API_KEY="$PAPERLESS_API_KEY" -- npx -y @buildpaperless/mcp

Claude Desktop (claude_desktop_config.json) and Cursor (mcp.json)

{
  "mcpServers": {
    "paperless": {
      "command": "npx",
      "args": ["-y", "@buildpaperless/mcp"],
      "env": { "PAPERLESS_API_KEY": "bp_..." }
    }
  }
}
  • Only what the key allows. The agent sees a tool only when the key holds its scope. Contacts and leads need their own scopes.
  • Money waits for a person. Variations and purchase orders are proposed, never created directly. Someone in your organisation approves each one in Paperless.

Treat job data as untrusted. Diary notes, defect descriptions and lead notes are typed by people, and a note can contain instructions aimed at your agent. Give the key the fewest scopes that do the job, and review anything the agent wants to send elsewhere.

Ready to start building?

Get your keys and make a call in the next ten minutes.