Shippy MCP Server

officiel

Expédiez du travail. Gagnez des redevances.

Documentation

Installation du serveur MCP

Shippy fournit un serveur Model Context Protocol (MCP) distant qui permet aux assistants de codage IA d'interagir avec vos bounties directement dans votre IDE.

Serveur MCP de documentation

Notez que nous proposons également un point de terminaison MCP distinct pour lire la documentation Shippy via MCP :

Point de terminaison : https://shippy.sh/mcp/docs

Ce point de terminaison ne nécessite aucune authentification et fournit deux outils :

OutilDescription
list_docsLister toutes les pages de documentation disponibles
read_docLire une page de documentation spécifique par son ID

Ceci est utile si vous souhaitez que votre assistant IA puisse consulter la documentation Shippy sans quitter votre IDE.

Fonctionnalités

Avec le serveur MCP Shippy, votre assistant IA peut :

Pour les contributeurs :

  • Parcourir et rechercher des bounties dans les projets
  • Lire les détails complets des bounties et les critères d'acceptation
  • Réclamer des bounties pour commencer à travailler
  • Soumettre le travail terminé pour révision
  • Voir et gérer vos réclamations actives

Pour les fondateurs :

  • Créer et mettre à jour des bounties
  • Fermer et rouvrir des bounties
  • Gérer les étiquettes de projet
  • Créer et configurer des projets (Mode Réputation ou Mode Partage des bénéfices)

Prérequis

  1. Un compte Shippy (inscrivez-vous ici)
  2. Un jeton d'accès MCP (générez-en un dans Paramètres utilisateur → Jetons d'accès MCP)

Installation rapide (Cursor)

Si vous utilisez Cursor, cliquez sur le bouton « Ajouter à Cursor » dans vos paramètres utilisateur après avoir généré un jeton. Ceci configurera automatiquement le serveur MCP.

Installation manuelle

Cursor

Ajoutez ceci à ~/.cursor/mcp.json :

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

Windsurf

Ajoutez ceci à ~/.codeium/windsurf/mcp_config.json :

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

Remarque : Windsurf utilise serverUrl au lieu de url pour les serveurs HTTP. Consultez la documentation MCP de Windsurf.

Codex (OpenAI)

Codex utilise une configuration TOML dans ~/.codex/config.toml. Vous avez deux options :

Option 1 : Jeton direct (plus simple)

Ajoutez ceci à ~/.codex/config.toml :

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

Option 2 : Variable d'environnement (plus sécurisée)

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

Définissez ensuite la variable d'environnement dans votre shell (ajoutez à ~/.zshrc ou ~/.bashrc) :

export SHIPPY_MCP_TOKEN="shp_YOUR_TOKEN"

Remarque : Consultez la documentation MCP de Codex pour plus d'options de configuration.

Claude Desktop

Claude Desktop ne prend en charge que les serveurs MCP basés sur stdio, vous aurez donc besoin de mcp-remote pour vous connecter au point de terminaison HTTP de Shippy.

Ajoutez à votre configuration 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 utilise également des serveurs basés sur stdio. Vous pouvez ajouter Shippy via l'interface en ligne de commande :

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

Ou ajoutez au .mcp.json de votre projet :


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


## Sécurité

* Votre jeton MCP est lié à votre compte Shippy
* Les jetons peuvent être révoqués à tout moment depuis vos paramètres
* Chaque jeton indique sa dernière utilisation pour l'audit
* Nous recommandons d'utiliser des jetons distincts pour différentes machines
* Le préfixe de jeton `shp_` active l'analyse des secrets GitHub

## Ressources

* Spécification du Model Context Protocol
* Documentation MCP de Cursor
* Documentation MCP de Windsurf
* Guide MCP de Claude Desktop
* mcp-remote sur npm

## Besoin d'aide ?

Envoyez un e-mail à [email protected]