Shippy MCP Server

การติดตั้งเซิร์ฟเวอร์ MCP

Shippy มีเซิร์ฟเวอร์ Model Context Protocol (MCP) ระยะไกลที่ช่วยให้ผู้ช่วยเขียนโค้ด AI สามารถโต้ตอบกับ bounties ของคุณได้โดยตรงใน IDE

เซิร์ฟเวอร์ MCP สำหรับเอกสาร

โปรดทราบว่าเรายังมีปลายทาง MCP แยกต่างหากสำหรับอ่านเอกสาร Shippy ผ่าน MCP:

ปลายทาง: https://shippy.sh/mcp/docs

ปลายทางนี้ไม่ต้องการการยืนยันตัวตนและมีเครื่องมือสองตัว:

เครื่องมือ	คำอธิบาย
list_docs	แสดงรายการหน้าเอกสารทั้งหมดที่มีอยู่
read_doc	อ่านหน้าเอกสารเฉพาะตาม ID

สิ่งนี้มีประโยชน์หากคุณต้องการให้ผู้ช่วย AI ของคุณสามารถอ้างอิงเอกสาร Shippy ได้โดยไม่ต้องออกจาก IDE

คุณสมบัติ

ด้วยเซิร์ฟเวอร์ Shippy MCP ผู้ช่วย AI ของคุณสามารถ:

สำหรับผู้ร่วมพัฒนา:

• เรียกดูและค้นหา bounties ในโปรเจกต์ต่างๆ
• อ่านรายละเอียด bounty และเกณฑ์การยอมรับทั้งหมด
• อ้างสิทธิ์ bounty เพื่อเริ่มทำงาน
• ส่งงานที่เสร็จแล้วเพื่อตรวจสอบ
• ดูและจัดการการอ้างสิทธิ์ที่ใช้งานอยู่ของคุณ

สำหรับผู้ก่อตั้ง:

• สร้างและอัปเดต bounties
• ปิดและเปิด bounties ใหม่
• จัดการป้ายกำกับโปรเจกต์
• สร้างและกำหนดค่าโปรเจกต์ (โหมดชื่อเสียง หรือ โหมดแบ่งปันกำไร)

ข้อกำหนดเบื้องต้น

1. บัญชี Shippy (สมัครที่นี่)
2. โทเค็นการเข้าถึง 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 ใช้ serverUrl แทน url สำหรับเซิร์ฟเวอร์ HTTP ดูเอกสาร Windsurf MCP

Codex (OpenAI)

Codex ใช้การกำหนดค่า TOML ใน ~/.codex/config.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"

จากนั้นตั้งค่าตัวแปรสภาพแวดล้อมในเชลล์ของคุณ (เพิ่มลงใน ~/.zshrc หรือ ~/.bashrc):

export SHIPPY_MCP_TOKEN="shp_YOUR_TOKEN"

หมายเหตุ: ดูเอกสาร Codex MCP สำหรับตัวเลือกการกำหนดค่าเพิ่มเติม

Claude Desktop

Claude Desktop รองรับเฉพาะเซิร์ฟเวอร์ MCP แบบ stdio ดังนั้นคุณจะต้องใช้ mcp-remote เพื่อเชื่อมต่อกับปลายทาง HTTP ของ Shippy

เพิ่มลงในการกำหนดค่า 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 คุณสามารถเพิ่ม Shippy ผ่าน CLI:

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

## แหล่งข้อมูล

* ข้อกำหนด Model Context Protocol
* เอกสาร Cursor MCP
* เอกสาร Windsurf MCP
* คู่มือ Claude Desktop MCP
* mcp-remote บน npm

## ต้องการความช่วยเหลือ?

อีเมล [email protected]