Skip to main content

nudg3-mcp

MCP server for Nudg3 brand visibility intelligence. Query your brand's AI search visibility from Claude Desktop, Cursor, Windsurf, or any MCP client.

Quickstart

1. Get an API key

Create one at app.nudg3.ai/api-keys.

Two key types (since 1.1.0):

  • Workspace-scoped key — bound to one workspace. The default for single-brand customers. Every tool just works; you don't pass workspace_id.
  • Agency / company-scoped key — bound to an agency or a company that owns multiple workspaces. Use list_workspaces first, then pass workspace_id to other tools. If the key only authorises one workspace the auto-resolver picks it for you; if it authorises many, the error response tells the LLM which UUIDs are available so it can ask you.

2. Configure Claude Desktop

Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json on Mac, %APPDATA%\Claude\claude_desktop_config.json on Windows):

{
  "mcpServers": {
    "nudg3": {
      "command": "uvx",
      "args": ["nudg3-mcp"],
      "env": {
        "NUDG3_API_KEY": "nudg3_live_ak_..."
      }
    }
  }
}

3. Ask questions

  • "What's my brand visibility score this week?"
  • "Compare my visibility across ChatGPT and Gemini"
  • "Which sources cite my brand most?"
  • "Export my dashboard data for the last 30 days"

Tools

Tool Scope Description
list_workspaces read:analytics New in 1.1.0. Portfolio discovery for agency/company keys. Workspace keys see a single-element list.
get_overview read:analytics Health check: organic + branded visibility, trends, alerts, suggested investigations
analyze_competitors read:analytics Organic competitive rankings, position gaps, fastest movers
analyze_prompts read:analytics Prompt-level performance by funnel stage; auto-resolves your primary brand
analyze_sources read:analytics Top cited domains, type distribution, content gap detection
analyze_responses read:analytics Provider-grouped response samples, sentiment patterns
query_metrics read:analytics Composable analytics query with measures, dimensions, filters
get_metric_catalog read:analytics Discover available measures, filters, and export datasets
export_data export:data CSV export for chat responses, sources, dashboard, prompts
get_reports read:insights List or fetch visibility audit reports
get_insights read:insights AI-generated opportunities, threats, and recommendations from a report
get_actions read:insights Workspace action items with priority, effort, and impact

Since 1.1.0, every analytics/insights/export tool accepts an optional workspace_id argument. Workspace-scoped key callers can omit it. Agency/company-scoped key callers pass the UUID returned by list_workspaces — when only one workspace is accessible, it's auto-resolved.

Environment Variables

Variable Required Default Description
NUDG3_API_KEY Yes Your Nudg3 API key
NUDG3_API_URL No https://api.nudg3.ai API base URL
NUDG3_TIMEOUT No 30 HTTP timeout in seconds

Other MCP Clients

Cursor

{
  "mcpServers": {
    "nudg3": {
      "command": "uvx",
      "args": ["nudg3-mcp"],
      "env": {
        "NUDG3_API_KEY": "nudg3_live_ak_..."
      }
    }
  }
}

Custom / programmatic

pip install nudg3-mcp
NUDG3_API_KEY=nudg3_live_ak_... nudg3-mcp

Development

git clone https://github.com/NUDG3-AI/nudg3-mcp-server.git
cd nudg3-mcp-server
python -m venv venv && source venv/Scripts/activate
pip install -e ".[dev]"
pytest

Release files for nudg3-mcp 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nudg3-mcp 1.1.0
File Size Uploaded
nudg3_mcp-1.1.0.tar.gz 58.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nudg3-mcp 1.1.0
File Interpreter ABI Platform
nudg3_mcp-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 109.1 kB

Release files / nudg3_mcp-1.1.0.tar.gz

Download URL nudg3_mcp-1.1.0.tar.gz
Size 58.7 kB
Tags Source
SHA-256 checksum
How to use checksums
297c80f579b2a4c973987d6f4f2b2f34e67ab22e7a9a344c2b07632c3c161439
BLAKE2b-256 checksum
How to use checksums
100fc203cd6d0be7cb20c5b1d4b8b4bec8179537c64f45a1be3f169db5d231da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.13

Release files / nudg3_mcp-1.1.0-py3-none-any.whl

Download URL nudg3_mcp-1.1.0-py3-none-any.whl
Size 50.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9d98ea4e651cc092977062b258224d35690e99b9e6f0c485595b369efc3df36b
BLAKE2b-256 checksum
How to use checksums
dfc5e37be9250c20e4bf49f9ffc0e6c3443eae6583483666d5ab5e064338d813
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.13

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page