Documentation Index
Fetch the complete documentation index at: https://docs.getsmartalex.com/llms.txt
Use this file to discover all available pages before exploring further.
MCP Server Overview
SmartAlex provides a fully-featured Model Context Protocol (MCP) server that lets AI assistants manage your entire voice agent platform through natural conversation.
What is MCP?
The Model Context Protocol is an open standard that connects AI assistants to external tools, data sources, and services. Instead of switching between dashboards, you can ask your AI assistant to manage contacts, launch campaigns, analyze calls, and track deals , all through conversation.
MCP is supported by Claude, Claude Code, Cursor, VS Code (GitHub Copilot), ChatGPT, Gemini CLI, and a growing ecosystem of AI clients.
What SmartAlex’s MCP Server Does
The SmartAlex MCP server exposes 28 tools, 7 resources, and 5 prompts , giving AI assistants full operational access to your SmartAlex workspace.
With it, you can:
- Manage contacts , list, create, update, and organize your contact database
- Create and configure voice agents , build agents from a website URL or with full customization, update settings with automatic voice platform sync
- Run campaigns , create campaigns, add contacts, start calling, and track progress
- Analyze calls , browse call history and read full transcripts with sentiment data
- Track deals , manage your sales pipeline from lead to closed
- Set up webhooks , create event-driven integrations with external systems
- Monitor the platform , check health, usage stats, and system status
SmartAlex exposes 28 tools organized across 8 domains. All tool names are prefixed with smartalex_ to avoid conflicts with other MCP servers.
| Tool | Description |
|---|
smartalex_list_contacts | List contacts with pagination (page, per_page) |
smartalex_get_contact | Get a single contact by UUID |
smartalex_create_contact | Create a new contact (first_name required) |
smartalex_update_contact | Partial update , only provided fields change |
| Tool | Description |
|---|
smartalex_list_agents | List all AI voice agents with name, language, and status |
smartalex_get_agent | Get full agent configuration by UUID |
smartalex_create_agent | Quick Setup , create an agent from a website URL (auto-scrapes, generates prompt) |
smartalex_create_agent_advanced | Advanced Setup , create a fully customized agent with name, objective, direction, and more |
smartalex_update_agent | Update agent settings (16 fields) with automatic voice platform sync and prompt regeneration |
smartalex_delete_agent | Permanently delete a voice agent |
| Tool | Description |
|---|
smartalex_list_phone_numbers | List all active phone numbers with country and agent assignment |
smartalex_search_available_numbers | Search available numbers by country (US, CA, GB, AU, NZ, FI, DK, NL, ZA) |
smartalex_buy_phone_number | Purchase a phone number (~$1.66/mo, first free on trial) |
| Tool | Description |
|---|
smartalex_list_campaigns | List all voice campaigns with status and agent assignment |
smartalex_get_campaign | Get campaign details including contact counts and call stats |
smartalex_create_campaign | Create a campaign , assign agent, set objective, configure hours |
smartalex_add_contacts_to_campaign | Add contacts to a campaign (max 100 per call, deduped) |
smartalex_start_campaign | Start a campaign to begin making calls |
| Tool | Description |
|---|
smartalex_list_calls | List call records with pagination (direction, call_status, duration_seconds, sentiment, cost) |
smartalex_get_call | Get full call detail including conversation transcript |
| Tool | Description |
|---|
smartalex_list_deals | List deals in pipeline, optionally filter by stage |
smartalex_create_deal | Create a new deal with name, stage, value, and contact |
smartalex_update_deal | Update deal stage, value, or other fields |
smartalex_delete_deal | Permanently delete a deal |
| Tool | Description |
|---|
smartalex_list_webhooks | List all active webhook subscriptions |
smartalex_create_webhook | Subscribe to events , returns a one-time signing_secret |
smartalex_delete_webhook | Unregister a webhook |
| Tool | Description |
|---|
smartalex_get_platform_status | Platform health + usage stats (contacts, campaigns, calls, deals) |
Resources (7)
Resources provide read-only data that AI assistants can access for context.
| Resource | URI | Description |
|---|
| Platform Status | smartalex://platform/status | Health, uptime, and usage stats |
| Agents | smartalex://agents | All configured voice agents |
| Campaigns | smartalex://campaigns/active | All campaigns with status, mode, and agent assignment |
| Recent Calls | smartalex://calls/recent | Last 25 calls with summary |
| Deals Pipeline | smartalex://deals/pipeline | Current pipeline and deal values |
| Contact Stats | smartalex://contacts/stats | Contact database overview (first 25) |
| Workflows | smartalex://workflows | 7 recommended multi-step workflow templates |
Prompts (5)
Prompts are pre-built conversation templates that guide AI assistants through complex multi-step tasks.
| Prompt | Description |
|---|
campaign-strategy | Design a campaign strategy based on your contacts, agents, and goals |
lead-qualification | Analyze and score leads using call transcripts and engagement data |
agent-design | Evaluate and improve voice agents , suggest optimizations, new agents, or retirements |
call-analysis | Deep analysis of call outcomes , sentiment, objections, and conversions |
pipeline-review | Review your pipeline , bottlenecks, at-risk deals, and forecast |
Supported AI Clients
SmartAlex MCP server works with any MCP-compatible client:
| Client | Transport | Status |
|---|
| Claude Code | HTTP (cloud) or stdio (local) | Fully supported |
| Claude Desktop | stdio (local) | Fully supported |
| Cursor | stdio (local) | Fully supported |
| VS Code (GitHub Copilot) | stdio (local) | Fully supported |
| Windsurf | stdio (local) | Fully supported |
| Gemini CLI | stdio (local) | Fully supported |
| ChatGPT | HTTP (cloud) | Supported via cloud endpoint |
| Custom clients | HTTP or stdio | Any MCP-compatible client works |
Authentication
SmartAlex MCP server supports two authentication methods:
API Keys
API keys use a prefixed format for easy identification:
- Production:
sa_live_ prefix (e.g., sa_live_abc123...)
- Test/Staging:
sa_test_ prefix (e.g., sa_test_xyz789...)
Generate API keys from the Developer Portal in your SmartAlex dashboard.
OAuth 2.0
For AI clients that support OAuth (like Claude Code’s HTTP transport), SmartAlex provides native OAuth 2.0 authentication. The server advertises its authorization server via the RFC 9728 Protected Resource Metadata endpoint.
Rate Limits
| Transport | Limit | Keyed by |
|---|
| Cloud (authenticated) | 100 requests/min | Workspace |
| Cloud (public/onboarding) | 30 requests/min | IP address |
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
When rate limited, the server returns HTTP 429 with a Retry-After header.
Architecture
The SmartAlex MCP server can run in two modes:
Local (stdio)
AI Client ←stdio→ @smartalex/mcp-server ←HTTPS→ SmartAlex API Gateway
Cloud (HTTP Streamable)
AI Client ←HTTPS→ SmartAlex Cloud MCP ←internal→ SmartAlex API Gateway
https://api.getsmartalex.com/functions/v1/mcp-server
Next Steps
