Skip to main content
The outlit setup command registers Outlit as an MCP server with your AI agent tools. Once configured, your agents can query customers, pull revenue metrics, search context, and run SQL — all from within your conversation.
If you already configured your agent manually using the MCP Integration guide, you don’t need outlit setup — both approaches connect to the same MCP server.

​
Supported Agents

AgentCommandHow it connects
Cursoroutlit setup cursorWrites to ~/.cursor/mcp.json
Claude Codeoutlit setup claude-codeRuns claude mcp add
Claude Desktopoutlit setup claude-desktopWrites to Claude Desktop config
VS Codeoutlit setup vscodeWrites to .vscode/mcp.json
Gemini CLIoutlit setup geminiRuns gemini mcp add
OpenClawoutlit setup openclawWrites skill to OpenClaw skills directory
Agent Skillsoutlit setup skillsInstalls Outlit agent skills via package runner

​
Auto-Setup

Detect and configure all installed agents at once: 
outlit setup --yes
Without --yes, the CLI lists detected agents before configuring. Agent skills are also installed automatically.

​
JSON Output

{
  "detected": ["cursor", "claude-code", "claude-desktop"],
  "configured": ["cursor", "claude-code", "claude-desktop"],
  "failed": [],
  "skills": { "success": true, "runner": "npx" }
}

​
Individual Setup

​
Cursor

outlit setup cursor
Adds Outlit to ~/.cursor/mcp.json: 
{
  "mcpServers": {
    "outlit": {
      "url": "https://mcp.outlit.ai/mcp",
      "headers": {
        "Authorization": "Bearer ok_your_api_key"
      }
    }
  }
}
Restart Cursor after setup.

​
Claude Code

outlit setup claude-code
Registers the MCP server using the Claude CLI. Requires claude to be installed.

​
Claude Desktop

outlit setup claude-desktop
Writes to the platform-specific Claude Desktop config:
PlatformConfig path
macOS~/Library/Application Support/Claude/claude_desktop_config.json
Windows%APPDATA%/Claude/claude_desktop_config.json
Linux~/.config/Claude/claude_desktop_config.json
Claude Desktop uses a command-based config (unlike Cursor’s HTTP URL approach): 
{
  "mcpServers": {
    "outlit": {
      "command": "outlit",
      "args": ["mcp", "serve"],
      "env": {
        "OUTLIT_API_KEY": "ok_your_api_key"
      }
    }
  }
}
Restart Claude Desktop after setup.

​
VS Code

outlit setup vscode
Writes to .vscode/mcp.json in the current working directory. Creates the .vscode/ directory if needed. Note: VS Code uses a servers key (not mcpServers).

​
Gemini CLI

outlit setup gemini
Registers the MCP server using the Gemini CLI. Requires gemini to be installed.

​
OpenClaw

outlit setup openclaw
Writes an Outlit intelligence skill to the OpenClaw skills directory. Checks ~/clawd/skills/ first, falls back to ~/.openclaw/skills/. OpenClaw loads skills automatically.

​
Agent Skills

outlit setup skills
Installs Outlit agent skills via your package runner. No API key required.

​
Diagnostics

The doctor command runs environment checks to verify your CLI and agent setup: 
outlit doctor

​
Checks Performed

CheckWhat it verifies
CLI versionWhether you’re running the latest version
API keyPresence and format of your API key
API validationLive test call to verify the key works
Per-agent checksEach detected agent gets its own check (e.g., “Cursor”, “Claude Code”)

​
Example Output

  Outlit Doctor

  ✓ CLI version: v0.1.0 (latest)
  ✓ API key: Found (ok_ab...1234) via config
  ✓ API validation: Key is valid
  ✓ Cursor: Installed, Outlit MCP configured
  ! Claude Code: Installed, but Outlit MCP not verified
  ✓ Claude Desktop: Installed, Outlit MCP configured

  Everything works, 1 suggestion(s).

​
JSON Output

outlit doctor --json

{
  "ok": true,
  "checks": [
    { "name": "CLI version", "status": "pass", "message": "v0.1.0 (latest)" },
    { "name": "API key", "status": "pass", "message": "Found (ok_ab...1234) via config" },
    { "name": "API validation", "status": "pass", "message": "Key is valid" },
    { "name": "Cursor", "status": "pass", "message": "Installed, Outlit MCP configured" }
  ]
}
Filter for failures: 
outlit doctor --json | jq '.checks[] | select(.status == "fail")'

​
Exit Code

doctor exits with code 1 if any check fails, making it useful in CI: 
outlit doctor || echo "Setup issues detected"

​
Shell Completions

Generate completion scripts for your shell: 
outlit completions bash >> ~/.bash_completion
source ~/.bash_completion