Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ghostlyx.com/llms.txt

Use this file to discover all available pages before exploring further.

What is the GhostlyX MCP server?

GhostlyX exposes a Model Context Protocol (MCP) server that allows AI coding assistants and agents to query your analytics data directly. Instead of copying numbers from the dashboard into a prompt, your AI assistant can retrieve live data on demand. MCP server URL: https://ghostlyx.com/mcp

Authentication

The MCP server uses API token authentication. Create a token in Settings > API Tokens > Create token. Tokens are read-only and have access to analytics data for all sites on your account. See API tokens for full instructions.

Compatible clients

  • Claude Desktop
  • Cursor
  • Windsurf
  • Any MCP-compatible client

Available tools

ToolDescription
get_site_statsSummary metrics (visitors, pageviews, bounce rate, duration) for a site and period
get_top_pagesTop pages by pageviews with visitor counts
get_traffic_sourcesTop referrers and traffic sources
get_realtime_visitorsCurrent active visitors (last 5 minutes)
list_goalsAll goals with completion counts and conversion rates
get_funnel_statsStep-by-step funnel conversion data
get_session_replay_statsRecording counts and UX signal summary
get_uptime_statusCurrent uptime status, response time, and 30-day uptime percentage
manage_annotationsList or create annotations on the trend chart

Configuration: Claude Desktop

Add the following to your claude_desktop_config.json:
{
  "mcpServers": {
    "ghostlyx": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://ghostlyx.com/mcp"],
      "env": { "API_TOKEN": "your-token-here" }
    }
  }
}
Replace your-token-here with the API token you created in GhostlyX.

Configuration: Cursor and Windsurf

Add the same JSON block to your MCP configuration file for those clients. Refer to the Cursor or Windsurf documentation for the exact file location.