Skip to main content

Getting Started

This guide will help you connect Phoenix to your MCP client and make your first API call.

Prerequisites​

  • A Phoenix account with API access
  • An MCP-compatible client (Claude Desktop, Cline, etc.)

Authentication​

Phoenix uses API keys for authentication. Each API key is scoped to your organization and provides access to all Phoenix MCP tools and REST APIs.

Get Your API Key​

  1. Log in to your Phoenix account
  2. Navigate to MCP in the sidebar
  3. Copy your API key from the MCP page
warning

Keep your API keys secure. Never commit them to version control or share them publicly.

OAuth Alternative

Phoenix also supports OAuth 2.1 for third-party integrations like ChatGPT. If you're building an application that needs user-delegated access, see the OAuth 2.1 Reference for full flow details.

MCP Setup​

Phoenix supports the Model Context Protocol (MCP), allowing AI assistants to directly access Phoenix data and capabilities.

Claude Desktop​

  1. Open Claude Desktop
  2. Navigate to Customize → Connectors (or visit claude.ai/customize/connectors)
  3. Add a new connector with the URL:
https://phoenix.hginsights.com/api/ai/YOUR_API_KEY/mcp

Replace YOUR_API_KEY with your actual Phoenix API key.

  1. Save and verify by asking Claude: "What Phoenix tools are available?"

Cline (VS Code Extension)​

  1. Open VS Code settings (Cmd/Ctrl + ,)
  2. Search for "Cline MCP"
  3. Click Edit in settings.json
  4. Add the Phoenix MCP server using HTTP transport:
{
  "cline.mcpServers": {
    "phoenix": {
      "url": "https://phoenix.hginsights.com/api/ai/YOUR_API_KEY/mcp"
    }
  }
}

Replace YOUR_API_KEY with your actual Phoenix API key.

  1. Reload VS Code
  2. Open Cline and verify Phoenix tools are available

Other MCP Clients​

Phoenix supports many MCP clients including Cursor, Windsurf, n8n, and ChatGPT. For detailed setup instructions for each client, see our MCP Clients Guide.

Quick connection details:

  • URL: https://phoenix.hginsights.com/api/ai/{YOUR_API_KEY}/mcp
  • Transport: Streamable HTTP
  • Authentication: API key in URL path

Replace {YOUR_API_KEY} with your actual Phoenix API key.

Verify Your Setup​

Once connected, your AI assistant should have access to Phoenix tools. Try asking:

  • "What companies are in the healthcare industry?"
  • "What technologies does Salesforce use?"
  • "Generate a research rule for enterprise SaaS companies"

Next Steps​

Troubleshooting​

Connection Issues​

If your MCP client can't connect to Phoenix:

  1. Verify your API key is correct
  2. Check that the API URL is properly formatted
  3. Ensure your network allows connections to Phoenix
  4. Review MCP client logs for error messages

Authentication Errors​

If you receive authentication errors:

  1. Regenerate your API key in Phoenix settings
  2. Update your MCP configuration with the new key
  3. Restart your MCP client

Tool Execution Errors​

If tools fail to execute:

  1. Check that you have the necessary permissions
  2. Verify the tool parameters match the expected schema
  3. Review the error message for specific guidance
  4. Contact support if the issue persists

Support​

Need help?