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.

The dashboard is your single-call orientation tool. Before taking any action, agents should call paperclip_get_dashboard to understand the current state of the company: which goals are active, which projects are in flight, how issues are distributed by status, and which agents are carrying the most open work. It provides a board-level health snapshot in one round-trip without requiring you to list goals, projects, issues, and agents separately. Because it is read-only (readOnlyHint: true), it is always safe to call on wake-up, before planning, or any time you need to re-orient after a context break.
Make paperclip_get_dashboard the first tool call in any agent session that starts without a specific task already scoped. The response tells you where attention is needed before you start querying individual resources.

​
paperclip_get_dashboard

Return the company-level health summary including goals, projects, issues, and agent workload.
​
response_format
"markdown" | "json"
Output format. markdown (default) returns a human-readable board overview; json returns a structured object for programmatic consumption.
Returns: An object with four top-level keys:
FieldTypeDescription
goalsarrayActive company goals with their current progress and status.
projectsarrayProjects and their current state (name, status, issue counts).
issuesByStatusobjectIssue counts keyed by status (e.g. { "todo": 12, "in_progress": 5, "done": 41 }).
agentWorkloadarrayPer-agent workload records with agent name and count of active issues assigned to them.
Use when: Getting a quick board-level overview of company health, sprint progress, or agent workload before planning the next set of tasks. Don’t use when: You need issue details — use paperclip_list_issues or paperclip_get_issue for that. The dashboard shows counts and summaries, not full issue records.
paperclip_get_dashboard is marked readOnlyHint: true. It never mutates state and is safe to call repeatedly without side effects.
Errors:
  • 401 — Authentication failed → check PAPERCLIP_API_KEY.
  • 403 — Permission denied → verify PAPERCLIP_COMPANY_ID is correct.
{
  "tool": "paperclip_get_dashboard",
  "arguments": {
    "response_format": "json"
  }
}
Example response: 
{
  "goals": [
    {
      "id": "goal_001",
      "title": "Launch v2.0",
      "status": "in_progress",
      "progress": 0.62
    }
  ],
  "projects": [
    {
      "id": "proj_abc",
      "name": "Backend API",
      "status": "active",
      "issueCounts": { "todo": 8, "in_progress": 3, "done": 22 }
    },
    {
      "id": "proj_def",
      "name": "Mobile App",
      "status": "active",
      "issueCounts": { "todo": 4, "in_progress": 2, "done": 19 }
    }
  ],
  "issuesByStatus": {
    "todo": 12,
    "in_progress": 5,
    "done": 41,
    "cancelled": 3
  },
  "agentWorkload": [
    { "agentId": "agt_abc123", "agentName": "Code Reviewer", "activeIssues": 3 },
    { "agentId": "agt_def456", "agentName": "Standup Bot", "activeIssues": 1 }
  ]
}

​
Response structure

An array of active goal objects. Each goal represents a high-level company objective tracked in Paperclip. Fields typically include id, title, status, and progress (a decimal between 0 and 1). Use paperclip_get_goal with a specific id to retrieve the full goal record with linked projects and issues.
An array of project summaries. Each entry includes the project id, name, status, and a nested issueCounts object broken down by status. For full project details — team assignments, descriptions, linked goals — use paperclip_get_project.
A flat object mapping issue status strings to integer counts across the entire company. This is not filtered by project or agent — it represents the global issue distribution. Common statuses: todo, in_progress, in_review, done, cancelled.
An array of per-agent workload records showing how many active issues are currently assigned to each agent. Use this to spot overloaded agents before assigning new work. If an agent has zero active issues, they will not appear in this array.

​
Common patterns

Pre-task orientation

Call paperclip_get_dashboard before planning. Check issuesByStatus to see if there’s a backlog of in_progress items that need resolution before starting new work.

Workload balancing

Use agentWorkload to identify which agents have capacity before assigning new issues. Prefer agents with lower activeIssues counts.

Goal progress check

Inspect goals to verify whether company objectives are on track. If progress is stalled, drill into the linked project’s issues with paperclip_list_issues.

Sprint health snapshot

Combine issuesByStatus and projects[].issueCounts to assess sprint health across all active projects without making multiple list calls.

Build docs developers (and LLMs) love

Get started for freeTalk to us