paperclip_get_dashboard
Get a quick board-level overview of company health, including goals, projects, issue counts by status, and agent workload.
Instructions
Return the company-level health summary including goals, projects, issues, and agent workload.
Args:
response_format: 'markdown' | 'json' (optional) — Output format (default: markdown)
Returns: Object with: goals (array), projects (array), issuesByStatus (object: counts per status), agentWorkload (array: agent name + active issue count).
Examples:
Use when: getting a quick board-level overview of company health or sprint progress
Don't use when: you need issue details — use paperclip_list_issues or paperclip_get_issue instead
Error Handling:
401: authentication failed → check PAPERCLIP_API_KEY
403: permission denied → verify PAPERCLIP_COMPANY_ID is correct
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| response_format | Yes | Output format: 'markdown' (default, human-readable) or 'json' (structured) | markdown |