Documentation

MCP Server

Connect PingAura to Claude, Cursor, Codex, VS Code, Perplexity, ChatGPT, Gemini CLI, and other AI clients via MCP. Access domains, visibility scores, audits, and articles from your AI assistant.

PingAura runs a remote MCP server. It lets AI assistants query your account data directly. This includes domains, visibility scores, site audits, and articles. You never have to leave your editor or chat interface.

Supported clients include Claude Code, Claude Desktop, Cursor, Codex, VS Code, Windsurf, Perplexity, ChatGPT, Gemini CLI, and Amazon Q.

Authentication

All requests require an API key generated from your team settings.

  1. Go to Settings > API Keys in your PingAura dashboard.
  2. Click Create API Key, give it a name, and copy the key.
  3. The key is shown once. Store it securely.

Key format: pa_XXXXXXXX_YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY

Use it in the Authorization header as either:

  • Authorization: Key pa_xxx_yyy
  • Authorization: Bearer pa_xxx_yyy

Only account owners can create and revoke keys. Team members can view existing keys.

Quick start

The fastest way to connect is with Claude Code:

claude mcp add pingaura --transport http https://www.pingaura.ai/api/mcp \
  --header "Authorization: Key YOUR_API_KEY"

Then ask Claude something like: "List my domains and their visibility scores"

Quick setup

Paste your API key to install PingAura directly into your editor.

Cursor iconInstall in CursorVS Code iconInstall in VS Code

Enter your API key to enable install buttons.

Client setup

Claude Code (CLI)

claude mcp add pingaura --transport http https://www.pingaura.ai/api/mcp \
  --header "Authorization: Key YOUR_API_KEY"

Verify with:

claude mcp list

No restart required.

Claude Desktop

Edit the config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "pingaura": {
      "url": "https://www.pingaura.ai/api/mcp",
      "headers": {
        "Authorization": "Key YOUR_API_KEY"
      }
    }
  }
}

Restart Claude Desktop after saving.

Cursor

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (project):

{
  "mcpServers": {
    "pingaura": {
      "url": "https://www.pingaura.ai/api/mcp",
      "headers": {
        "Authorization": "Key YOUR_API_KEY"
      }
    }
  }
}

Or go to Settings > Cursor Settings > MCP and add the server there. No restart required.

Codex

Codex supports MCP servers in the CLI and IDE extension.

Use the PingAura MCP endpoint:

  • Server URL: https://www.pingaura.ai/api/mcp
  • Authorization header: Key YOUR_API_KEY

For a step-by-step guide, follow OpenAI's Codex MCP setup. Use the PingAura server URL and API key shown above.

VS Code (GitHub Copilot)

Add to .vscode/mcp.json in your project:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "pingaura-api-key",
      "description": "PingAura API Key",
      "password": true
    }
  ],
  "servers": {
    "pingaura": {
      "type": "http",
      "url": "https://www.pingaura.ai/api/mcp",
      "headers": {
        "Authorization": "Key ${input:pingaura-api-key}"
      }
    }
  }
}

VS Code will prompt you for the API key on first use.

Windsurf

Edit ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "pingaura": {
      "serverUrl": "https://www.pingaura.ai/api/mcp",
      "headers": {
        "Authorization": "Key YOUR_API_KEY"
      }
    }
  }
}

Note: Windsurf uses serverUrl instead of url.

Amazon Q Developer

Add to ~/.aws/amazonq/mcp.json:

{
  "mcpServers": {
    "pingaura": {
      "type": "http",
      "url": "https://www.pingaura.ai/api/mcp",
      "headers": {
        "Authorization": "Key YOUR_API_KEY"
      }
    }
  }
}

Perplexity

Perplexity supports custom remote MCP connectors on paid plans.

  1. Open the Perplexity app and go to Account Settings > Connectors.
  2. Click + Custom connector and select Remote.
  3. Fill in the details:
    • Display name: PingAura
    • MCP Server URL: https://www.pingaura.ai/api/mcp
    • Description: AI visibility scores, site audits, articles, and competitor data from PingAura
    • Authentication: Select API Key and enter your PingAura API key
    • Transport: Select Streamable HTTP
  4. Check the acknowledgement box and click Add.
  5. Click the PingAura connector card to enable it.

Once enabled, ask Perplexity questions like "What's my latest visibility score?" It will query PingAura directly.

ChatGPT

ChatGPT supports remote MCP servers through Developer Mode. This is available on Plus, Pro, and Team plans.

  1. Open ChatGPT on the web or desktop app.
  2. Open a new chat and enable Developer Mode from the model picker.
  3. Click the Tools icon (wrench) in the composer, then Add MCP connector.
  4. Enter the details:
    • Name: PingAura
    • URL: https://www.pingaura.ai/api/mcp
    • Authentication: Select API Key and enter your PingAura API key
  5. Click Add to save.

Once connected, ChatGPT can call PingAura tools in Developer Mode chats.

Gemini CLI

Edit ~/.gemini/settings.json (global) or .gemini/settings.json (project):

{
  "mcpServers": {
    "pingaura": {
      "httpUrl": "https://www.pingaura.ai/api/mcp",
      "headers": {
        "Authorization": "Key YOUR_API_KEY"
      }
    }
  }
}

Note: Gemini CLI uses httpUrl instead of url.

Available tools

Once connected, your AI assistant has access to these tools:

Read tools

ToolDescription
list-domainsList all domains in your account
get-domainGet details for a specific domain
list-competitorsList competitor domains tracked for a domain
list-visibility-runsList visibility analysis runs
get-visibility-summaryGet scores, coverage, and competitor comparison for a run
get-prompt-scoresGet visibility scores for tracked prompts/queries
list-site-auditsList site health audit history
get-audit-issuesGet issues from an audit (filter by severity or category)
list-articlesList AI-generated articles
get-articleGet full article content
list-site-pagesList discovered pages for a domain
get-account-infoGet account details and subscription status
get-quota-usageGet quota usage for prompts, articles, site audits, and chat
get-site-health-summaryGet site health summary with scores, issue counts, and priority fixes

Write tools

ToolDescription
create-promptCreate a new visibility prompt for a domain
archive-promptArchive or restore a prompt
update-prompt-topicMove a prompt to a different topic
manage-prompt-topicsCreate, update, or delete prompt topics
update-articleUpdate article metadata (title, slug, status, keywords, meta description)
publish-articlePublish an article
delete-articleDelete an article
run-site-auditQueue a site health audit for tracked pages
update-issue-statusMark a site health issue as resolved or reopen it
add-competitorAdd competitor domains to tracking
update-competitorUpdate a competitor's display name or aliases
delete-competitorRemove a competitor from tracking

Example prompts

Once PingAura is connected, try asking your AI assistant:

  • "Show me all my domains and their current status"
  • "What's the latest visibility score for example.com?"
  • "List the critical audit issues for my homepage"
  • "Show me all published articles and their word counts"
  • "Compare my visibility scores against competitors"
  • "Which pages have the most visitors?"
  • "Get the AEO issues from the latest audit"
  • "Archive the prompt about delivery services"
  • "Add hubspot.com as a competitor for my domain"
  • "Mark that broken-links issue as resolved"
  • "Publish my latest article"
  • "How much of my prompt quota have I used?"

Access control

  • API keys are scoped to a team account. All data returned is isolated to that account.
  • Only account owners can create, update, or revoke API keys.
  • Team members can view existing keys but cannot manage them.
  • Keys support optional expiration dates.
  • Revoked keys are immediately rejected.

Troubleshooting

"Unauthorized" error

  • Check that your API key is correct and not revoked.
  • Ensure the header format is Authorization: Key pa_xxx_yyy or Authorization: Bearer pa_xxx_yyy.

Tools not showing up

  • Run claude mcp list (Claude Code) or check MCP status in your client.
  • Verify the URL is exactly https://www.pingaura.ai/api/mcp.

Connection timeout

  • The MCP server is stateless — each request is independent. If you're behind a firewall, ensure outbound HTTPS to www.pingaura.ai is allowed.