Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nudj.cx/llms.txt

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

The Nudj MCP Server connects Nudj features to AI agents through the Model Context Protocol. It runs over HTTP (streaming / SSE) on port 4010, and exposes a stdio transport for desktop clients.

Who this is for

Authentication

Every HTTP request to the MCP server requires two headers:
Authorization: Bearer <NUDJ_MCP_TOKEN>
x-api-domain:  https://<subdomain>.nudj.cx/api/v2/admin
Tokens are minted from Admin Panel → Settings → Developer → MCP Tokens, scoped to your RBAC role (Viewer / Moderator / Manager / Admin / SuperAdmin). The MCP server validates the token and enforces that its claimed organisation matches x-api-domain. See Bearer + Domain Headers for full details. stdio transports (Claude Desktop) use env vars instead of headers.

Tool catalog

The MCP server exposes a set of tools categorised by concern. Tool availability is further filtered by the x-agent-mode header — see Agent modes.

Nudj platform CRUD

Core domain operations that read and write Nudj data.
ToolOperations
communitiesCRUD on communities
challengesCRUD on challenges (with video metadata)
actionsCRUD on engagement actions (28+ action types)
achievementsCRUD on achievements / badges / milestones
rewardsCRUD on rewards
reward_allocationsDistribute rewards via challenge, achievement, action, leaderboard, manual, or giveaway
leaderboardsManage leaderboard configurations
postsPublish and edit admin posts (HTML content)
analytics28 analytics operations across users, communities, challenges, achievements, rewards
themeGet / update organisation theme configuration

Shopify

Shop-level integration for Shopify-backed organisations.
ToolOperations
shopify16 operations: get_shop, list_products, get_product, list_collections, list_orders, list_customers, get_customer_segments, list_discounts, analyze_products, get_store_health, get_discount_conflicts, get_widget_settings, set_widget_enabled, update_widget_theme, update_launcher_config, update_points_for_spend
The Shopify MCP surface includes context injection: the agent starts each session with a pre-fetched snapshot of shop state so it can answer questions without an initial round of API calls.

Public web & media

Tools that don’t require Nudj auth. Useful for research and content generation.
ToolOperations
webSearch the web, scrape page content
social_postsRetrieve social media posts
youtube_channelFetch channel info and video lists
youtube_videoFetch video metadata and transcripts
imageGenerate, edit, upscale, background-remove, inpaint, outpaint images (FAL.ai + Nano Banana Pro)

Docs & events

ToolOperations
nudj_docsSearch the Nudj documentation
watchSubscribe to Nudj events and receive real-time updates

Voice agent

A realtime voice-agent layer sits on top of the MCP tool catalog. Tool availability is filtered to the same x-agent-mode rules; the voice transport itself is a thin shell.

Agent modes

The server filters tool access based on the x-agent-mode header, so you can hand a narrower surface to less-trusted agents:
ModeSurface
plannerRead-only Nudj operations plus public web/media tools
builderFull read-write on Nudj resources
servicePublic web and media tools only, no Nudj access
If x-agent-mode is omitted, the server defaults to the broadest surface your token’s RBAC role allows.

Transports

Serves MCP over streaming HTTP / SSE. All cloud-hosted clients (Claude Code, Cursor, ChatGPT) use this.
EnvironmentURL
Productionhttps://mcp.nudj.cx/sse
Developmenthttps://mcp-dev.nudj.cx/sse
Localhttp://localhost:4010/mcp

stdio

Used by Claude Desktop and other native desktop clients that spawn the server as a child process. See MCP Admin Setup for the canonical config.

Local development

For contributors working on the MCP server itself:
cd apps/mcp-server
NODE_TLS_REJECT_UNAUTHORIZED=0 pnpm dev   # HTTP on :4010
The TLS bypass is needed because the local Nudj API uses a self-signed cert. All three apps (admin, API, MCP) must share the same NEXTAUTH_SECRET so tokens validate end-to-end. See Claude Code Setup for the full local config.

Admin / Claude Desktop

Admin panel MCP tokens and Claude Desktop stdio config.

Claude Code .mcp.json

Wire up Claude Code with .mcp.json for cloud or local.

Bearer + Domain Headers

The canonical auth pattern for HTTP MCP clients.

Troubleshooting

Diagnose auth, connection, and tool-call issues.