Shippy MCP Server

chính thức

Giao hàng. Nhận tiền bản quyền.

Xem trên shippy.sh

Tài liệu

Cài đặt MCP Server

Shippy cung cấp một máy chủ Model Context Protocol (MCP) từ xa cho phép các trợ lý lập trình AI tương tác trực tiếp với các bounty của bạn ngay trong IDE.

MCP Server Tài liệu

Lưu ý rằng chúng tôi cũng cung cấp một điểm cuối MCP riêng để đọc tài liệu Shippy qua MCP:

Điểm cuối: https://shippy.sh/mcp/docs

Điểm cuối này không yêu cầu xác thực và cung cấp hai công cụ:

Công cụMô tả
list_docsLiệt kê tất cả các trang tài liệu có sẵn
read_docĐọc một trang tài liệu cụ thể theo ID

Điều này hữu ích nếu bạn muốn trợ lý AI của mình có thể tham khảo tài liệu Shippy mà không cần rời khỏi IDE.

Tính năng

Với máy chủ Shippy MCP, trợ lý AI của bạn có thể:

Dành cho Người đóng góp:

  • Duyệt và tìm kiếm bounty trên các dự án
  • Đọc chi tiết đầy đủ của bounty và tiêu chí chấp nhận
  • Nhận bounty để bắt đầu làm việc
  • Gửi công việc đã hoàn thành để xem xét
  • Xem và quản lý các nhận bounty đang hoạt động

Dành cho Người sáng lập:

  • Tạo và cập nhật bounty
  • Đóng và mở lại bounty
  • Quản lý nhãn dự án
  • Tạo và cấu hình dự án (Chế độ Uy tín hoặc Chế độ Chia sẻ Lợi nhuận)

Điều kiện tiên quyết

  1. Một tài khoản Shippy (đăng ký tại đây)
  2. Một mã thông báo truy cập MCP (tạo trong Cài đặt Người dùng → Mã thông báo Truy cập MCP)

Cài đặt Nhanh (Cursor)

Nếu bạn đang sử dụng Cursor, hãy nhấp vào nút "Thêm vào Cursor" trong cài đặt người dùng sau khi tạo mã thông báo. Thao tác này sẽ tự động cấu hình máy chủ MCP.

Cài đặt Thủ công

Cursor

Thêm phần này vào ~/.cursor/mcp.json:

{
  "mcpServers": {
    "shippy": {
      "url": "https://shippy.sh/mcp",
      "headers": {
        "Authorization": "Bearer shp_YOUR_TOKEN"
      }
    }
  }
}

Windsurf

Thêm phần này vào ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "shippy": {
      "serverUrl": "https://shippy.sh/mcp",
      "headers": {
        "Authorization": "Bearer shp_YOUR_TOKEN"
      }
    }
  }
}

Lưu ý: Windsurf sử dụng serverUrl thay vì url cho các máy chủ HTTP. Xem tài liệu Windsurf MCP.

Codex (OpenAI)

Codex sử dụng cấu hình TOML trong ~/.codex/config.toml. Bạn có hai tùy chọn:

Tùy chọn 1: Mã thông báo trực tiếp (đơn giản hơn)

Thêm phần này vào ~/.codex/config.toml:

[mcp_servers.shippy]
url = "https://shippy.sh/mcp"
http_headers = { "Authorization" = "Bearer shp_YOUR_TOKEN" }

Tùy chọn 2: Biến môi trường (an toàn hơn)

[mcp_servers.shippy]
url = "https://shippy.sh/mcp"
bearer_token_env_var = "SHIPPY_MCP_TOKEN"

Sau đó đặt biến môi trường trong shell của bạn (thêm vào ~/.zshrc hoặc ~/.bashrc):

export SHIPPY_MCP_TOKEN="shp_YOUR_TOKEN"

Lưu ý: Xem tài liệu Codex MCP để biết thêm các tùy chọn cấu hình.

Claude Desktop

Claude Desktop chỉ hỗ trợ các máy chủ MCP dựa trên stdio, vì vậy bạn sẽ cần mcp-remote để kết nối với điểm cuối HTTP của Shippy.

Thêm vào cấu hình Claude Desktop của bạn:

  • 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 cũng sử dụng các máy chủ dựa trên stdio. Bạn có thể thêm Shippy qua CLI:

claude mcp add shippy -- npx -y mcp-remote https://shippy.sh/mcp --header "Authorization: Bearer shp_YOUR_TOKEN"

Hoặc thêm vào .mcp.json của dự án:


### 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


## Bảo mật

* Mã thông báo MCP của bạn được liên kết với tài khoản Shippy
* Mã thông báo có thể bị thu hồi bất kỳ lúc nào từ cài đặt của bạn
* Mỗi mã thông báo hiển thị thời điểm sử dụng cuối cùng để kiểm tra
* Chúng tôi khuyên bạn nên sử dụng các mã thông báo riêng cho các máy khác nhau
* Tiền tố mã thông báo `shp_` cho phép quét bí mật GitHub

## Tài nguyên

* Đặc tả Model Context Protocol
* Tài liệu Cursor MCP
* Tài liệu Windsurf MCP
* Hướng dẫn Claude Desktop MCP
* mcp-remote trên npm

## Cần Trợ giúp?

Gửi email tới [email protected]