@ferrypost/mcp-server
v0.1.0
Published
MCP server for the Ferry Post messaging API
Downloads
25
Maintainers
Readme
@ferrypost/mcp-server
Model Context Protocol (MCP) server for the Ferry Post messaging API.
Exposes 34 tools covering the full API surface, enabling AI agents to send messages, manage conversations, configure webhooks, and more.
Installation
npm install -g @ferrypost/mcp-serverUsage
stdio transport (local agent)
MESSAGING_API_KEY=msgk_live_... ferrypost-mcpHTTP transport (hosted)
MESSAGING_API_URL=https://ferrypost.com ferrypost-mcp-httpClients authenticate via Authorization: Bearer msgk_live_... header. The API key is forwarded to the Ferry Post API.
The HTTP server exposes:
POST /mcp-- JSON-RPC requestsGET /mcp-- SSE stream for server-to-client notificationsDELETE /mcp-- session termination
Claude Desktop configuration
Add to your claude_desktop_config.json:
{
"mcpServers": {
"ferrypost": {
"command": "npx",
"args": ["ferrypost-mcp"],
"env": {
"MESSAGING_API_KEY": "msgk_live_your_api_key_here"
}
}
}
}Tools
| Category | Tools | |---|---| | Messages | send, get, list, edit, unsend, search, react, unreact | | Scheduled Messages | create, list, update, cancel | | Conversations | list, get, create, update, messages, add-participant, remove-participant | | Webhooks | list, create, update, delete, test | | Phone Numbers | list, get, health | | Opt-Outs | check, add | | Channels | list, capabilities | | Organization | get, list-members, invite, remove-member | | Analytics | get | | Telegram | list, get, start-auth, verify-code, submit-2fa, disconnect, health |
Programmatic usage
import { createMcpServer } from '@ferrypost/mcp-server';
const server = createMcpServer({
apiBaseUrl: 'https://ferrypost.com',
apiKey: 'msgk_live_...',
});Environment variables
| Variable | Description | Default |
|---|---|---|
| MESSAGING_API_URL | Base URL of the Ferry Post API | Required for HTTP transport |
| MESSAGING_API_KEY | API key for authentication | Required for stdio transport |
| MCP_PORT | Port for HTTP transport | 3100 |
| MCP_HOST | Host for HTTP transport | 0.0.0.0 |
Documentation
Full API documentation is available at docs.ferrypost.com.
License
MIT
