mcp
Model Context Protocol (MCP) Server for the mcp API.
[!IMPORTANT] This MCP Server is not yet ready for production use. Delete this notice before publishing to a package manager.
Summary
Convoy API Reference: Convoy is a fast and secure webhooks proxy. This document contains s API specification.
Table of Contents
Installation
MCP Bundle (Desktop Extension)
Install the MCP server as a Desktop Extension using the pre-built mcp-server.mcpb file:
Simply drag and drop the mcp-server.mcpb file onto Claude Desktop to install the extension.
The MCP bundle package includes the MCP server and all necessary configuration. Once installed, the server will be available without additional setup.
[!NOTE] MCP bundles provide a streamlined way to package and distribute MCP servers. Learn more about Desktop Extensions.
Cursor
Or manually:
- Open Cursor Settings
- Select Tools and Integrations
- Select New MCP Server
- If the configuration file is empty paste the following JSON into the MCP Server Configuration:
{
"mcpServers": {
"Convoy": {
"command": "npx",
"args": [
"@subomi/convoy-mcp-typescript",
"start",
"--bearer-auth",
"..."
]
}
}
}
Claude Code CLI
claude mcp add @subomi/convoy-mcp-typescript npx @subomi/convoy-mcp-typescript start -- --bearer-auth ...
Windsurf
Refer to Official Windsurf documentation for latest information
- Open Windsurf Settings
- Select Cascade on left side menu
- Click on
Manage MCPs. (To Manage MCPs you should be signed in with a Windsurf Account) - Click on
View raw configto open up the mcp configuration file. - If the configuration file is empty paste the full json
{
"mcpServers": {
"Convoy": {
"command": "npx",
"args": [
"@subomi/convoy-mcp-typescript",
"start",
"--bearer-auth",
"..."
]
}
}
}
VS Code
Refer to Official VS Code documentation for latest information
- Open Command Palette
- Search and open
MCP: Open User Configuration. This should open mcp.json file - If the configuration file is empty paste the full json
{
"mcpServers": {
"Convoy": {
"command": "npx",
"args": [
"@subomi/convoy-mcp-typescript",
"start",
"--bearer-auth",
"..."
]
}
}
}
Claude Desktop
Claude Desktop doesn't yet support SSE/remote MCP servers.You need to do the following
- Open claude Desktop
- Open left hand side pane, then click on your Username
- Go to
Settings - Go to
Developertab (on the left hand side) - Click on
Edit ConfigPaste the following config in the configuration
{
"mcpServers": {
"Convoy": {
"command": "npx",
"args": [
"@subomi/convoy-mcp-typescript",
"start",
"--bearer-auth",
"..."
]
}
}
}
Stdio installation via npm
To start the MCP server, run:npx @subomi/convoy-mcp-typescript start --bearer-auth ...
For a full list of server arguments, run:
npx @subomi/convoy-mcp-typescript --help
Development
Run locally without a published npm package:
- Clone this repository
- Run
npm install - Run
npm run build - Run
node ./bin/mcp-server.js start --bearer-auth ...To use this local version with Cursor, Claude or other MCP Clients, you'll need to add the following config:
{
"mcpServers": {
"SDK": {
"command": "node",
"args": [
"./bin/mcp-server.js",
"start",
"--bearer-auth",
"..."
]
}
}
}
Or to debug the MCP server locally, use the official MCP Inspector:
npx @modelcontextprotocol/inspector node ./bin/mcp-server.js start --bearer-auth ...
Contributions
While we value contributions to this MCP Server, the code is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.