Shippy MCP Server
官方運送工作,賺取版稅。
文件
MCP 伺服器安裝
Shippy 提供一個遠端模型上下文協定 (MCP) 伺服器,讓 AI 編碼助手可以直接在您的 IDE 中與您的賞金任務互動。
文件 MCP 伺服器
請注意,我們也提供一個獨立的 MCP 端點,用於透過 MCP 讀取 Shippy 文件:
端點:https://shippy.sh/mcp/docs
此端點無需驗證,並提供兩個工具:
| 工具 | 說明 |
|---|---|
| list_docs | 列出所有可用的文件頁面 |
| read_doc | 透過 ID 讀取特定文件頁面 |
如果您希望 AI 助手能夠在不離開 IDE 的情況下參考 Shippy 文件,這將非常有用。
功能
透過 Shippy MCP 伺服器,您的 AI 助手可以:
針對貢獻者:
- 瀏覽和搜尋跨專案的賞金任務
- 讀取完整的賞金任務詳細資訊和驗收標準
- 領取賞金任務以開始工作
- 提交完成的工作以供審查
- 檢視和管理您進行中的領取
針對創辦人:
- 建立和更新賞金任務
- 關閉和重新開啟賞金任務
- 管理專案標籤
- 建立和設定專案(聲譽模式或利潤分享模式)
先決條件
- 一個 Shippy 帳戶(在此註冊)
- 一個 MCP 存取權杖(在您的使用者設定 → MCP 存取權杖中產生)
快速安裝 (Cursor)
如果您使用 Cursor,在產生權杖後,點擊使用者設定中的「新增至 Cursor」按鈕。這將自動設定 MCP 伺服器。
手動安裝
Cursor
將此新增至 ~/.cursor/mcp.json:
{
"mcpServers": {
"shippy": {
"url": "https://shippy.sh/mcp",
"headers": {
"Authorization": "Bearer shp_YOUR_TOKEN"
}
}
}
}
Windsurf
將此新增至 ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"shippy": {
"serverUrl": "https://shippy.sh/mcp",
"headers": {
"Authorization": "Bearer shp_YOUR_TOKEN"
}
}
}
}
注意:Windsurf 針對 HTTP 伺服器使用
serverUrl而非url。請參閱 Windsurf MCP 文件。
Codex (OpenAI)
Codex 在 ~/.codex/config.toml 中使用 TOML 設定。您有兩個選項:
選項 1:直接使用權杖(較簡單)
將此新增至 ~/.codex/config.toml:
[mcp_servers.shippy]
url = "https://shippy.sh/mcp"
http_headers = { "Authorization" = "Bearer shp_YOUR_TOKEN" }
選項 2:環境變數(較安全)
[mcp_servers.shippy]
url = "https://shippy.sh/mcp"
bearer_token_env_var = "SHIPPY_MCP_TOKEN"
然後在您的 shell 中設定環境變數(新增至 ~/.zshrc 或 ~/.bashrc):
export SHIPPY_MCP_TOKEN="shp_YOUR_TOKEN"
注意:請參閱 Codex MCP 文件以獲取更多設定選項。
Claude Desktop
Claude Desktop 僅支援基於 stdio 的 MCP 伺服器,因此您需要 mcp-remote 才能連接到 Shippy 的 HTTP 端點。
新增至您的 Claude Desktop 設定:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"shippy": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://shippy.sh/mcp",
"--header",
"Authorization: Bearer shp_YOUR_TOKEN"
]
}
}
}
Claude Code
Claude Code 也使用基於 stdio 的伺服器。您可以透過 CLI 新增 Shippy:
claude mcp add shippy -- npx -y mcp-remote https://shippy.sh/mcp --header "Authorization: Bearer shp_YOUR_TOKEN"
或新增至您專案的 .mcp.json:
### Other Clients (stdio-only)
For other MCP clients that only support stdio transport (not Streamable HTTP), use mcp-remote with the same configuration pattern as Claude Desktop above.
> Note: Cursor 0.50+ and Windsurf support Streamable HTTP natively. Claude Desktop, Claude Code, and older clients require mcp-remote.
## Available Tools
### Read Operations
| Tool | Description | Auth |
| --------------------- | ----------------------------------------------------- | ---------- |
| list\_projects | Browse projects on Shippy | Optional\* |
| read\_project | Get project details by slug | Optional\* |
| list\_bounties | List bounties for a project | Optional\* |
| read\_bounty | Get bounty by identifier (e.g., "SHP-42") | Optional\* |
| list\_labels | List all labels for a project | Optional\* |
| read\_label | Get label details by ID | Optional\* |
| list\_comments | List comments on a bounty | Optional\* |
| list\_attachments | List attachments for a bounty, submission, or comment | Optional\* |
| list\_my\_bounties | List bounties you have claimed | Required |
| list\_my\_submissions | List your submissions | Required |
\*Optional: Works without auth for public projects. With auth, also shows your private projects.
### Contributor Operations
| Tool | Description |
| ------------------------------ | ------------------------------------------------ |
| claim\_bounty | Claim a bounty to start working on it |
| release\_claim | Release your claim on a bounty |
| create\_submission | Submit work for a claimed bounty |
| update\_submission | Update a draft/pending submission |
| suggest\_bounty | Suggest a new bounty for founder review |
| create\_comment | Add a comment to a bounty (supports attachments) |
| update\_comment | Update your own comment |
| delete\_comment | Delete a comment (author or founder) |
| get\_contributor\_agreement | View project's contributor agreement |
| accept\_contributor\_agreement | Accept project's contributor agreement |
### Attachment Operations
| Tool | Description |
| ---------------------------- | -------------------------------------------------- |
| generate\_nanoid | Generate a unique ID for pre-uploading attachments |
| get\_attachment\_upload\_url | Get a signed URL to upload a file to R2 |
| create\_attachment | Register an uploaded attachment |
| delete\_attachment | Delete an attachment |
Attachments can be added to bounties, submissions, and comments. For comments, use the `PENDING_COMMENT` reference type when uploading before the comment exists, then pass the generated ID to `create_comment`.
### Founder Operations
| Tool | Description |
| --------------------- | ------------------------------------------------------ |
| create\_bounty | Create a new bounty for a project |
| update\_bounty | Update bounty title, description, points, etc. |
| close\_bounty | Close a bounty (expires claims) |
| reopen\_bounty | Reopen a closed bounty |
| create\_label | Create a new label for a project |
| update\_label | Update label name or color |
| delete\_label | Delete a label from a project |
| create\_project | Create a new project (reputation or profit share mode) |
| update\_project | Update project settings |
| update\_project\_logo | Update or remove project logo |
## Example Usage
Once connected, try prompts like:
> "What bounties am I working on?"
> "Show me bounty SHP-42"
> "List open bounties on the shippy project"
> "Claim bounty SHP-15"
> "Submit my work for SHP-15 with description: Implemented the dark mode toggle. See PR #42."
> "Update submission sub\_123 with description: Added screenshots and test results."
> "Update submission sub\_123 to status: PENDING"
> "Add a comment on SHP-42: Great work! Here's my feedback..."
> "Upload a screenshot to my comment on SHP-42"
For Founders:
> "Create a bounty for my project 'shippy' titled 'Add dark mode support' with 50 points"
> "Update SHP-42 to have 100 points"
> "Create a label called 'urgent' with color #FF0000 for my shippy project"
> "Create a reputation mode project called 'my-oss-project' for open source contributions"
> "Create a profit share project with 10% pool percentage and monthly payouts"
## Troubleshooting
### Server not connecting
1. Verify your token is correct and hasn't been deleted
2. Make sure you're using the correct config file path for your IDE
3. Restart your IDE after making config changes
4. Check that Shippy is accessible at https://shippy.sh/mcp
### Authentication errors
1. Check that your token starts with `shp_`
2. Ensure the `Authorization` header format is `Bearer shp_YOUR_TOKEN` (with a space)
3. Generate a new token if the current one isn't working
### Tools not appearing
1. Make sure the MCP server is enabled in your IDE's settings
2. Check your IDE's MCP logs for connection errors
3. Try refreshing/reloading the MCP server list
### 406 Not Acceptable errors
If you're building your own MCP client, ensure your requests include:
Accept: application/json, text/event-stream
## 安全性
* 您的 MCP 權杖與您的 Shippy 帳戶綁定
* 權杖可以隨時從您的設定中撤銷
* 每個權杖都會顯示上次使用時間以供稽核
* 我們建議對不同機器使用獨立的權杖
* 權杖前綴 `shp_` 可啟用 GitHub 秘密掃描
## 資源
* 模型上下文協定規範
* Cursor MCP 文件
* Windsurf MCP 文件
* Claude Desktop MCP 指南
* npm 上的 mcp-remote
## 需要協助?
Email [email protected]