cordialmcp
v1.0.0
Published
Standalone MCP extension for Cordial marketing platform
Maintainers
Readme
Cordial MCP Standalone Extension
A standalone TypeScript MCP extension for the Cordial marketing platform, designed to work with Claude Desktop and as an npm package.
Features
All tools from the main MCP server:
- get_account_info - Retrieve comprehensive account configuration
- get_customer_info - Get customer details by email
- get_batch_emails_by_created_date - Fetch emails by creation date
- get_batch_emails_by_send_date - Fetch emails by send date
- get_email_template - Get specific email template
- get_audience_count_by_criteria - Calculate audience size by criteria
- get_audience_count_by_id - Get audience count by ID
Quick Start with npx
Run directly without installation:
# Set your API credentials
export API_KEY="your-cordial-api-key"
export API_URL="https://api.use1.cordial.io" # Optional, defaults to this URL
# Run with npx
npx cordialMCPOr inline:
API_KEY="your-key" npx cordialMCPInstallation Options
Option 1: Run with npx (Recommended for Users)
No installation needed:
API_KEY="your-key" npx cordialMCPOption 2: Global Installation
Install once, run anywhere:
npm install -g cordialmcp
cordialMCPOption 3: Claude Desktop Extension
For Claude Desktop integration:
Install Dependencies
cd standalone npm installBuild the Extension
npm run buildPack the Extension
npm run packThis creates a
cordial-mcp.mcpbfile.Install in Claude Desktop Drag and drop the
.mcpbfile into Claude Desktop, or double-click to install.Configure Claude Desktop will prompt you for:
- API URL: Your Cordial API URL (default: https://api.cordial.com)
- API Key: Your Cordial API key (stored securely in OS keychain)
Authentication
The extension uses the same authentication pattern as the main server (cordial_auth.py):
- The API key is used directly as a Bearer token
- Token serves as both authentication credential and client identifier
- Credentials are stored securely in the OS keychain
Development
Watch Mode
For development with auto-rebuild:
npm run devProject Structure
standalone/
├── manifest.json # Extension metadata and user config
├── package.json # Dependencies and scripts
├── tsconfig.json # TypeScript configuration
├── src/
│ ├── index.ts # Main MCP server implementation
│ └── cordial-client.ts # Cordial API client with auth
└── server/ # Compiled JavaScript outputConfiguration
The extension reads configuration from environment variables automatically provided by Claude Desktop:
API_URL- Cordial API base URLAPI_KEY- Cordial API authentication key
These map to the user_config section in manifest.json.
