Shippy MCP Server

oficial

Trabalhe com navios. Ganhe royalties.

Ver em shippy.sh

Documentação

Instalação do Servidor MCP

O Shippy fornece um servidor remoto Model Context Protocol (MCP) que permite que assistentes de codificação com IA interajam com suas recompensas diretamente no seu IDE.

Servidor MCP de Documentação

Note que também fornecemos um endpoint MCP separado para ler a documentação do Shippy via MCP:

Endpoint: https://shippy.sh/mcp/docs

Este endpoint não requer autenticação e fornece duas ferramentas:

FerramentaDescrição
list_docsLista todas as páginas de documentação disponíveis
read_docLê uma página de documentação específica por ID

Isso é útil se você quiser que seu assistente de IA possa consultar a documentação do Shippy sem sair do seu IDE.

Funcionalidades

Com o servidor MCP do Shippy, seu assistente de IA pode:

Para Contribuidores:

  • Navegar e buscar recompensas entre projetos
  • Ler detalhes completos de recompensas e critérios de aceitação
  • Reivindicar recompensas para começar a trabalhar
  • Enviar trabalho concluído para revisão
  • Visualizar e gerenciar suas reivindicações ativas

Para Fundadores:

  • Criar e atualizar recompensas
  • Fechar e reabrir recompensas
  • Gerenciar etiquetas de projeto
  • Criar e configurar projetos (Modo Reputação ou Modo Compartilhamento de Lucros)

Pré-requisitos

  1. Uma conta no Shippy (cadastre-se aqui)
  2. Um token de acesso MCP (gere um em Configurações do Usuário → Tokens de Acesso MCP)

Instalação Rápida (Cursor)

Se você estiver usando o Cursor, clique no botão "Adicionar ao Cursor" nas suas configurações de usuário após gerar um token. Isso configurará automaticamente o servidor MCP.

Instalação Manual

Cursor

Adicione isto ao ~/.cursor/mcp.json:

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

Windsurf

Adicione isto ao ~/.codeium/windsurf/mcp_config.json:

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

Nota: O Windsurf usa serverUrl em vez de url para servidores HTTP. Consulte a documentação MCP do Windsurf.

Codex (OpenAI)

O Codex usa configuração TOML em ~/.codex/config.toml. Você tem duas opções:

Opção 1: Token direto (mais simples)

Adicione isto ao ~/.codex/config.toml:

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

Opção 2: Variável de ambiente (mais seguro)

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

Em seguida, defina a variável de ambiente no seu shell (adicione ao ~/.zshrc ou ~/.bashrc):

export SHIPPY_MCP_TOKEN="shp_YOUR_TOKEN"

Nota: Consulte a documentação MCP do Codex para mais opções de configuração.

Claude Desktop

O Claude Desktop suporta apenas servidores MCP baseados em stdio, então você precisará do mcp-remote para conectar ao endpoint HTTP do Shippy.

Adicione à configuração do 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

O Claude Code também usa servidores baseados em stdio. Você pode adicionar o Shippy via CLI:

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

Ou adicione ao .mcp.json do seu projeto:


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


## Segurança

* Seu token MCP está vinculado à sua conta Shippy
* Tokens podem ser revogados a qualquer momento nas suas configurações
* Cada token mostra quando foi usado pela última vez para auditoria
* Recomendamos usar tokens separados para máquinas diferentes
* O prefixo de token `shp_` permite a varredura de segredos do GitHub

## Recursos

* Especificação do Model Context Protocol
* Documentação MCP do Cursor
* Documentação MCP do Windsurf
* Guia MCP do Claude Desktop
* mcp-remote no npm

## Precisa de Ajuda?

Envie um e-mail para [email protected]