mirror of
https://github.com/paperclipai/paperclip
synced 2026-04-25 17:25:15 +02:00
77 lines
1.9 KiB
Markdown
77 lines
1.9 KiB
Markdown
# Paperclip MCP Server
|
|
|
|
Model Context Protocol server for Paperclip.
|
|
|
|
This package is a thin MCP wrapper over the existing Paperclip REST API. It does
|
|
not talk to the database directly and it does not reimplement business logic.
|
|
|
|
## Authentication
|
|
|
|
The server reads its configuration from environment variables:
|
|
|
|
- `PAPERCLIP_API_URL` - Paperclip base URL, for example `http://localhost:3100`
|
|
- `PAPERCLIP_API_KEY` - bearer token used for `/api` requests
|
|
- `PAPERCLIP_COMPANY_ID` - optional default company for company-scoped tools
|
|
- `PAPERCLIP_AGENT_ID` - optional default agent for checkout helpers
|
|
- `PAPERCLIP_RUN_ID` - optional run id forwarded on mutating requests
|
|
|
|
## Usage
|
|
|
|
```sh
|
|
npx -y @paperclipai/mcp-server
|
|
```
|
|
|
|
Or locally in this repo:
|
|
|
|
```sh
|
|
pnpm --filter @paperclipai/mcp-server build
|
|
node packages/mcp-server/dist/stdio.js
|
|
```
|
|
|
|
## Tool Surface
|
|
|
|
Read tools:
|
|
|
|
- `paperclipMe`
|
|
- `paperclipInboxLite`
|
|
- `paperclipListAgents`
|
|
- `paperclipGetAgent`
|
|
- `paperclipListIssues`
|
|
- `paperclipGetIssue`
|
|
- `paperclipGetHeartbeatContext`
|
|
- `paperclipListComments`
|
|
- `paperclipGetComment`
|
|
- `paperclipListIssueApprovals`
|
|
- `paperclipListDocuments`
|
|
- `paperclipGetDocument`
|
|
- `paperclipListDocumentRevisions`
|
|
- `paperclipListProjects`
|
|
- `paperclipGetProject`
|
|
- `paperclipListGoals`
|
|
- `paperclipGetGoal`
|
|
- `paperclipListApprovals`
|
|
- `paperclipGetApproval`
|
|
- `paperclipGetApprovalIssues`
|
|
- `paperclipListApprovalComments`
|
|
|
|
Write tools:
|
|
|
|
- `paperclipCreateIssue`
|
|
- `paperclipUpdateIssue`
|
|
- `paperclipCheckoutIssue`
|
|
- `paperclipReleaseIssue`
|
|
- `paperclipAddComment`
|
|
- `paperclipUpsertIssueDocument`
|
|
- `paperclipRestoreIssueDocumentRevision`
|
|
- `paperclipLinkIssueApproval`
|
|
- `paperclipUnlinkIssueApproval`
|
|
- `paperclipApprovalDecision`
|
|
- `paperclipAddApprovalComment`
|
|
|
|
Escape hatch:
|
|
|
|
- `paperclipApiRequest`
|
|
|
|
`paperclipApiRequest` is limited to paths under `/api` and JSON bodies. It is
|
|
meant for endpoints that do not yet have a dedicated MCP tool.
|