Looking for Claude Desktop? If you prefer the desktop app, see the Claude Desktop guide instead.
Requirements
Every person who wants to use the Extole MCP must complete setup individually. You’ll need:- Claude Code installed
- An active Extole user account
Setup
Choose your authentication method. See the MCP authentication guide if you’re not sure which to use.Option 1: Extole CLI (Quickest)
If you have the Extole CLI installed, one command configures Claude Code automatically:extole serve remove
Start a new Claude Code session and you’re ready. To remove the registration: extole serve remove.
Option 2: OAuth via CLI
Step 1: Add the Extole MCP server/mcp
Step 2: Start a new Claude Code session
/mcp
Step 3: Authenticate with Extole
- Run
/mcpto open the MCP servers list. - Navigate to the Extole entry and select it.
- Press Enter to select Authenticate.
- Your browser will open to an Extole authorization page.
- Review the permissions and click Authorize.
/mcp list.
Option 3: API Key
Use this method for automated workflows, CI/CD pipelines, or shared environments. Step 1: Get your API key Generate one at the My.Extole Security Center. Step 2: Edit your Claude Code MCP config Add the following to.mcp.json (project-level) or ~/.claude/mcp.json (global):
.mcp.json
To keep credentials out of version control, use an environment variable:
~/.claude/mcp.json
Then set EXTOLE_API_KEY in your shell environment.
Step 3: Start a new Claude Code session
EXTOLE_API_KEY
The Extole MCP server will load automatically.
Using the MCP
Once connected, interact with your Extole programs in any Claude Code session:“Pull the conversion report for my refer-a-friend program for the past 30 days.”
“What’s the current advocate reward in the holiday campaign?”
“Update the friend coupon value in campaign X to 15% off.”By default, Claude Code will prompt you to approve each MCP tool call. To pre-approve all Extole tools, start Claude Code with:
mcp__extole__*
Or add mcp__extole__* to the allowedTools list in your Claude Code settings.
Write operations — Actions that modify programs, rewards, or campaign components execute immediately under your Extole permissions and are recorded in the Extole change log. Review tool calls carefully before approving write operations.
