Loading documentation...
Preparing Ring content
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Preparing Ring content
Preparing Ring content
Preparing Ring content
Connect Cursor, Claude Desktop, or any MCP host to a running Ring clone and operate entities, news, store, messaging, and generative media from natural language.
Ring ships a service-token HTTP gateway at /api/mcp/v1/* on each clone. The stdio server ring-mcp (AI-RING/ring-mcp/) exposes ring-* tools that call that gateway as a synthetic SUPERADMIN actor. This section documents individual tools; the full operator manual lives under Ring MCP Server.
Install ring-mcp, configure tokens, full 58-tool catalog, troubleshooting.
Provider architecture, env block, admin UI — shared backend for image tools.
Draft 480p vs production 720p, remaster workflow, CLI manifest.
RING_MCP_ACCESS_KEY, image generation keys, ring-filebase storage.
Model Context Protocol (MCP) is an open standard for connecting AI applications to external data and tools. Ring implements MCP in two layers:
| Layer | Package / server | Scope |
|---|---|---|
| Per-clone operator | ring-mcp → /api/mcp/v1/* | One white-label instance (this section) |
| Kingdom-wide | legiox-mcp, ringdom-mcp, reggie-mcp | AI-CONTEXT, deployment, propagation across Ringdom |
Ring's user-facing REST routes use Auth.js session cookies. The MCP gateway validates Authorization: Bearer against RING_MCP_ACCESS_KEY and injects a service actor — see Ring MCP Server — Architecture.
| Requirement | Notes |
|---|---|
| Node.js 20+ | Ring Platform baseline |
| Running Ring clone | npm run dev or production deploy |
RING_MCP_ACCESS_KEY | On the Ring app .env.local |
RING_MCP_ACCESS_KEY | In Cursor .cursor/mcp.json — must match one server token |
ring-mcp registered | AI-RING/ring-mcp/ring-mcp-server.js in MCP client config |
Each card links to a dedicated reference page. Pages are added as tools ship.
Generate images via ImageConductor (xAI / Google Imagen) → ring-filebase CDN URL.
Generate videos via VideoConductor — draft 480p or production 720p remaster.
Additional ring-* tools (entities, news, store, ring-news-generate, etc.) are documented in the Ring MCP Server operator manual. Per-tool pages under /docs/mcp/ will appear here as they are authored.
All /api/mcp/v1/* handlers return uniform JSON:
Destructive ring-* mutations require confirm: true in tool arguments — do not bypass in wrappers.
Connect Cursor, Claude Desktop, or any MCP host to a running Ring clone and operate entities, news, store, messaging, and generative media from natural language.
Ring ships a service-token HTTP gateway at /api/mcp/v1/* on each clone. The stdio server ring-mcp (AI-RING/ring-mcp/) exposes ring-* tools that call that gateway as a synthetic SUPERADMIN actor. This section documents individual tools; the full operator manual lives under Ring MCP Server.
Install ring-mcp, configure tokens, full 58-tool catalog, troubleshooting.
Provider architecture, env block, admin UI — shared backend for image tools.
Draft 480p vs production 720p, remaster workflow, CLI manifest.
RING_MCP_ACCESS_KEY, image generation keys, ring-filebase storage.
Model Context Protocol (MCP) is an open standard for connecting AI applications to external data and tools. Ring implements MCP in two layers:
| Layer | Package / server | Scope |
|---|---|---|
| Per-clone operator | ring-mcp → /api/mcp/v1/* | One white-label instance (this section) |
| Kingdom-wide | legiox-mcp, ringdom-mcp, reggie-mcp | AI-CONTEXT, deployment, propagation across Ringdom |
Ring's user-facing REST routes use Auth.js session cookies. The MCP gateway validates Authorization: Bearer against RING_MCP_ACCESS_KEY and injects a service actor — see Ring MCP Server — Architecture.
| Requirement | Notes |
|---|---|
| Node.js 20+ | Ring Platform baseline |
| Running Ring clone | npm run dev or production deploy |
RING_MCP_ACCESS_KEY | On the Ring app .env.local |
RING_MCP_ACCESS_KEY | In Cursor .cursor/mcp.json — must match one server token |
ring-mcp registered | AI-RING/ring-mcp/ring-mcp-server.js in MCP client config |
Each card links to a dedicated reference page. Pages are added as tools ship.
Generate images via ImageConductor (xAI / Google Imagen) → ring-filebase CDN URL.
Generate videos via VideoConductor — draft 480p or production 720p remaster.
Additional ring-* tools (entities, news, store, ring-news-generate, etc.) are documented in the Ring MCP Server operator manual. Per-tool pages under /docs/mcp/ will appear here as they are authored.
All /api/mcp/v1/* handlers return uniform JSON:
Destructive ring-* mutations require confirm: true in tool arguments — do not bypass in wrappers.
Connect Cursor, Claude Desktop, or any MCP host to a running Ring clone and operate entities, news, store, messaging, and generative media from natural language.
Ring ships a service-token HTTP gateway at /api/mcp/v1/* on each clone. The stdio server ring-mcp (AI-RING/ring-mcp/) exposes ring-* tools that call that gateway as a synthetic SUPERADMIN actor. This section documents individual tools; the full operator manual lives under Ring MCP Server.
Install ring-mcp, configure tokens, full 58-tool catalog, troubleshooting.
Provider architecture, env block, admin UI — shared backend for image tools.
Draft 480p vs production 720p, remaster workflow, CLI manifest.
RING_MCP_ACCESS_KEY, image generation keys, ring-filebase storage.
Model Context Protocol (MCP) is an open standard for connecting AI applications to external data and tools. Ring implements MCP in two layers:
| Layer | Package / server | Scope |
|---|---|---|
| Per-clone operator | ring-mcp → /api/mcp/v1/* | One white-label instance (this section) |
| Kingdom-wide | legiox-mcp, ringdom-mcp, reggie-mcp | AI-CONTEXT, deployment, propagation across Ringdom |
Ring's user-facing REST routes use Auth.js session cookies. The MCP gateway validates Authorization: Bearer against RING_MCP_ACCESS_KEY and injects a service actor — see Ring MCP Server — Architecture.
| Requirement | Notes |
|---|---|
| Node.js 20+ | Ring Platform baseline |
| Running Ring clone | npm run dev or production deploy |
RING_MCP_ACCESS_KEY | On the Ring app .env.local |
RING_MCP_ACCESS_KEY | In Cursor .cursor/mcp.json — must match one server token |
ring-mcp registered | AI-RING/ring-mcp/ring-mcp-server.js in MCP client config |
Each card links to a dedicated reference page. Pages are added as tools ship.
Generate images via ImageConductor (xAI / Google Imagen) → ring-filebase CDN URL.
Generate videos via VideoConductor — draft 480p or production 720p remaster.
Additional ring-* tools (entities, news, store, ring-news-generate, etc.) are documented in the Ring MCP Server operator manual. Per-tool pages under /docs/mcp/ will appear here as they are authored.
All /api/mcp/v1/* handlers return uniform JSON:
Destructive ring-* mutations require confirm: true in tool arguments — do not bypass in wrappers.