Skip to content

trycourier/courier-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

120 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Courier MCP Server

The official Model Context Protocol (MCP) server for the Courier notification API. It gives AI agents full access to the Courier API — send messages, manage profiles, debug deliveries, configure lists, and more — through 63 tools backed by the @trycourier/courier Node SDK.

Install

Hosted (recommended)

Courier runs a hosted MCP server at https://mcp.courier.com. No local setup required.

Install in Cursor

Cursor — add to .cursor/mcp.json:

{
  "mcpServers": {
    "courier": {
      "url": "https://mcp.courier.com",
      "headers": {
        "api_key": "YOUR_COURIER_API_KEY"
      }
    }
  }
}

Claude Code:

claude mcp add courier --transport http --url https://mcp.courier.com --header "api_key: YOUR_COURIER_API_KEY"

Claude Desktop — add to claude_desktop_config.json:

{
  "mcpServers": {
    "courier": {
      "url": "https://mcp.courier.com",
      "headers": {
        "api_key": "YOUR_COURIER_API_KEY"
      }
    }
  }
}

Local development

git clone https://github.com/trycourier/courier-mcp.git
cd courier-mcp
sh dev.sh

Then point your IDE at http://localhost:3000 with the same config format above.

Tools

63 tools organized by API resource. The hosted server registers all tools; local installs use a default subset (36 core tools) unless configured otherwise.

Core tools (default)

Category Tools
Send send_message, send_message_template, send_message_to_list, send_message_to_list_template
Messages list_messages, get_message, get_message_content, get_message_history, cancel_message
Profiles get_user_profile_by_id, create_or_merge_user, replace_profile, delete_profile, get_user_list_subscriptions, subscribe_user_to_lists, delete_user_list_subscriptions
Lists list_lists, get_list, get_list_subscribers, create_list, subscribe_user_to_list, unsubscribe_user_from_list
Audiences get_audience, list_audience_members, list_audiences, update_audience, delete_audience
Notifications list_notifications, get_notification_content, get_notification_draft_content
Brands create_brand, get_brand, list_brands
Auth generate_jwt_for_user
User Tokens list_user_push_tokens, get_user_push_token, create_or_replace_user_push_token
Docs courier_installation_guide

Advanced tools (hosted server only)

Category Tools
Automations invoke_automation_template, invoke_ad_hoc_automation
Bulk create_bulk_job, add_bulk_users, run_bulk_job, get_bulk_job, list_bulk_users
Audit Events get_audit_event, list_audit_events
Inbound track_inbound_event
Tenants get_tenant, create_or_update_tenant, list_tenants, delete_tenant
Users get_user_preferences, update_user_preference_topic, list_user_tenants, add_user_to_tenant, remove_user_from_tenant
Translations get_translation, update_translation
Config get_environment_config
SDK Context get_courier_sdk_context, scan_courier_imports, get_courier_sdk_component_map

Architecture

courier-mcp/
├── mcp/                    # MCP package (@trycourier/courier-mcp on npm)
│   └── src/
│       ├── index.ts        # CourierMcp server class
│       ├── tools/          # Tool definitions (one file per API resource)
│       └── utils/          # Config, error handling, registry
├── server/                 # Express server (hosts the MCP package via HTTP)
│   └── src/index.ts        # Stateless HTTP handler
└── dev.sh                  # Local development launcher

The MCP package uses the official @trycourier/courier Node SDK (Stainless-generated) for all API calls. The SDK stays in sync with the Courier API spec automatically, so tool implementations are thin wrappers with proper error handling.

Configuration

Header Required Description
api_key Yes Your Courier API key. Get one at app.courier.com/settings/api-keys.
base_url No Override the API base URL. Defaults to https://api.courier.com.

Development

# Install dependencies
cd mcp && npm install && cd ../server && npm install && cd ..

# Start development server
sh dev.sh

# Run tests
cd mcp && npm test

# Build
cd mcp && npm run build

Links

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors