Getting Started with SmartAlex MCP
Connect SmartAlex to your AI assistant in under 2 minutes. Once connected, you can manage voice agents, campaigns, contacts, and deals through natural conversation. Pick your assistant to jump straight to its setup:ChatGPT
Hosted cloud endpoint. No install.
Claude Desktop
Edit one config file.
Claude Code
A single command.
Cursor
Add to
.cursor/mcp.json.Gemini CLI
Add to
settings.json.VS Code
Add to
.vscode/mcp.json.Prerequisites
- A SmartAlex account at getsmartalex.com
- An API key (generate one from the Developer Portal in your dashboard)
- Node.js 18+ (for local installation only)
Quick Install
Cloud Connection (Recommended)
No installation required. Connect directly to SmartAlex’s hosted MCP endpoint using OAuth:Local Installation
Run locally via npx (no global install needed):SMARTALEX_API_KEY environment variable to be set.
Client Configuration
Claude Code
Cloud (recommended):Claude Desktop
Add to your Claude Desktop configuration file: macOS:~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Cursor
Add to.cursor/mcp.json in your project root (or global config):
VS Code (GitHub Copilot)
Add to.vscode/mcp.json in your project:
Gemini CLI
Add to your Gemini CLI settings file: Location:~/.gemini/settings.json
/mcp to connect.
ChatGPT
ChatGPT connects to SmartAlex via the cloud MCP endpoint using OAuth. Add the SmartAlex MCP server in ChatGPT’s MCP settings with:Windows Note
On Windows, usecmd as the command wrapper:
Authentication Setup
Getting Your API Key
- Log in to getsmartalex.com
- Open the Developer Portal from the side navigation
- Generate a new API key
- Choose your environment:
- Production keys start with
sa_live_ - Test keys start with
sa_test_
- Production keys start with
- Copy the key immediately, it won’t be shown again
Environment Variables
OAuth 2.0 (Cloud)
Cloud connections use OAuth 2.0. When connecting via HTTP transport, your AI client will open a browser window for authentication. No manual token management needed.Your First Tool Call
Once connected, try asking your AI assistant:“Show me my SmartAlex contacts”The assistant will use the
smartalex_list_contacts tool and return your contacts:
More Examples
Check platform health:“What’s the status of my SmartAlex platform?”Analyze recent calls:
“Show me my recent calls”Create a contact:
“Add a new contact: John Smith, john@acme.com, +1 555 987 6543”Review your pipeline:
“Show me all deals in the offer stage”Create a campaign:
“Create an outbound campaign called Q2 Outreach”
Cloud vs Local
Recommendation: Use cloud for the fastest setup. Use local if your organization requires local-only tool execution or you want to pin a specific version.
Troubleshooting
”Authentication failed” or “Invalid API key”
- Verify your key starts with
sa_live_(production) orsa_test_(test) - Regenerate the key from the Developer Portal if it may be expired
- Check the environment variable is set:
Tools not appearing after connecting
- Restart your AI client after configuration changes
- For Claude Desktop: fully quit and reopen (not just close the window)
- For Cursor: use the command palette > “Reload Window”
- For Claude Code: run
/mcpto check server status
”reconnection failed” (Cloud)
The cloud MCP server runs in stateless mode. If you see a reconnection error, simply reconnect, each request is independent and doesn’t require a persistent session.Rate Limiting
If you see HTTP 429 responses, you’ve exceeded the rate limit (100 req/min per workspace for authenticated, 30 req/min per IP for public). Wait for theRetry-After header duration and retry. Most AI clients handle this automatically.
First run is slow (Local)
The firstnpx @smartalex/mcp-server downloads the package (~20 kB + dependencies). Subsequent runs use the cached version and start in under 2 seconds.
Next Steps
- npm Package Setup, Detailed local installation guide with version pinning, updating, and per-client setup
- Usage Examples, Real-world workflows and conversation examples
- Tools Reference, Complete reference for all 28 tools with parameters and examples
- Error Reference, Error codes and troubleshooting
- MCP Overview, Architecture, resources, prompts, and workflows

