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.

Companies are the top-level tenant boundary in Paperclip — every issue, agent, project, label, and secret belongs to a company. The PAPERCLIP_COMPANY_ID environment variable scopes all non-board tools to a single company, so agents typically work within one company without needing these tools directly. The five company tools are board-level operations for provisioning and managing the companies themselves: listing all tenants, creating new ones, reading full configuration, updating settings like name and budget, and archiving companies that are no longer needed.
All company tools are board-only — they require a board (human-user) API key. Agent API keys receive a 403 Forbidden response even for read operations. This applies to all five tools including paperclip_list_companies and paperclip_get_company.

List Companies

Discover all companies accessible to the board user

Create Company

Provision a new company tenant on the board

Get Company

Read full configuration for a specific company

Update Company

Change name, description, or monthly budget

Archive Company

Permanently archive a decommissioned company

​
paperclip_list_companies

List all companies accessible to the authenticated board user, returning a paginated envelope.
​
limit
integer
Maximum companies per page. Range 1–100. Defaults to 50.
​
offset
integer
Number of companies to skip for pagination. Defaults to 0.
​
response_format
"markdown" | "json"
Output format. markdown (default) produces a human-readable list; json returns a structured envelope.
Returns: Pagination envelope { items: Company[], total, count, offset, limit, has_more, next_offset }. Each Company item contains: id, name, description, status, issuePrefix, budgetMonthlyCents, createdAt. Usage notes:
  • Use to discover all company IDs before looking up a specific company by UUID.
  • If you already have the companyId, use paperclip_get_company directly for full details.
Errors:
CodeMeaningResolution
401Authentication failedCheck PAPERCLIP_API_KEY
403Board key requiredThis endpoint requires board-level authentication
{
  "tool": "paperclip_list_companies",
  "arguments": {
    "limit": 50,
    "response_format": "json"
  }
}

​
paperclip_create_company

Create a new company tenant on the board. The issuePrefix is auto-generated from the company name and cannot be set manually.
​
name
string
required
Company name. Must be non-empty. The issuePrefix (e.g. PAP) is derived automatically from this value.
​
description
string | null
Company description. Optional; pass null or omit to leave blank.
​
budgetMonthlyCents
integer
Monthly budget cap in cents (non-negative integer). For example, 5000 = $50.00. Omit for no budget limit.
Returns: The created company object with all fields including the assigned UUID, auto-generated issuePrefix, status: 'active', and timestamps. Usage notes:
  • Use when onboarding a new organization or setting up a new tenant on the board.
  • To modify an existing company, use paperclip_update_company instead.
Errors:
CodeMeaningResolution
400Validation failureEnsure name is non-empty
401Authentication failedCheck PAPERCLIP_API_KEY
403Board key requiredThis endpoint requires board-level authentication
{
  "tool": "paperclip_create_company",
  "arguments": {
    "name": "Acme Corp",
    "description": "Acme Corporation engineering workspace",
    "budgetMonthlyCents": 100000
  }
}

​
paperclip_get_company

Get the full configuration record for a single company by UUID.
​
companyId
string
required
Company UUID (e.g. 00000000-0000-0000-0000-000000000000).
​
response_format
"markdown" | "json"
Output format. markdown (default) or json for structured output.
Returns: Full company object: id, name, description, status, issuePrefix, issueCounter, budgetMonthlyCents, spentMonthlyCents, requireBoardApprovalForNewAgents, feedbackDataSharingEnabled, brandColor, logoAssetId, pauseReason, pausedAt, createdAt, updatedAt. Usage notes:
  • Use to read a company’s budget, spending, status, or branding configuration.
  • To discover company IDs first, use paperclip_list_companies.
Errors:
CodeMeaningResolution
401Authentication failedCheck PAPERCLIP_API_KEY
403Board key requiredThis endpoint requires board-level authentication
404Company not foundVerify the ID with paperclip_list_companies
{
  "tool": "paperclip_get_company",
  "arguments": {
    "companyId": "00000000-0000-0000-0000-000000000000",
    "response_format": "json"
  }
}

​
paperclip_update_company

Update a company’s name, description, or monthly budget cap. Requires board-level authentication — agent keys are rejected even for CEO agents.
​
companyId
string
required
Company UUID.
​
name
string
New company name. Must be non-empty if provided.
​
description
string | null
New description. Pass null to clear an existing description.
​
budgetMonthlyCents
integer
New monthly budget cap in cents (non-negative integer). For example, 10000 = $100.00.
Returns: The updated company object with all fields and updated timestamps. Usage notes:
  • Use when adjusting a company’s monthly budget cap or renaming it after a rebrand.
  • To archive the company (status transition), use paperclip_archive_company — this tool does not modify status.
  • This operation is idempotent — calling it multiple times with the same values is safe.
Errors:
CodeMeaningResolution
401Authentication failedCheck PAPERCLIP_API_KEY
403Board key requiredAgent keys are not accepted for this endpoint
404Company not foundVerify the ID with paperclip_list_companies
{
  "tool": "paperclip_update_company",
  "arguments": {
    "companyId": "00000000-0000-0000-0000-000000000000",
    "budgetMonthlyCents": 200000,
    "description": "Acme Corporation — Q3 workspace"
  }
}

​
paperclip_archive_company

Archive a company, permanently setting its status to archived. This action is irreversible through the API — archived companies cannot be un-archived via any tool.
This tool has destructiveHint: true. Archiving is irreversible through the API. Once a company is archived, all its agents, issues, and projects become inaccessible. Ensure you have exported any data you need before archiving.
​
companyId
string
required
Company UUID to archive.
Returns: The updated company object with status: 'archived' and updated timestamps. Usage notes:
  • Use when decommissioning a company that is no longer in use.
  • To update other company fields (name, budget), use paperclip_update_company instead.
  • Consider running paperclip_export_company first to preserve a snapshot of the company’s data.
Errors:
CodeMeaningResolution
401Authentication failedCheck PAPERCLIP_API_KEY
403Board key requiredThis endpoint requires board-level authentication
404Company not foundVerify the ID with paperclip_list_companies
{
  "tool": "paperclip_archive_company",
  "arguments": {
    "companyId": "00000000-0000-0000-0000-000000000000"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us