-
Notifications
You must be signed in to change notification settings - Fork 0
RGX MCP
tools/rgx-mcp/ is a temporary read-only MCP (Model Context Protocol) fixture used by source-tree CI to validate, audit, and generate declarative RGX addons against the framework's frozen Simplicity Contract. It is never part of the Lua/XML/media addon archive.
| Tool | What it does |
|---|---|
rgx_validate_addon |
Validate an RGXAddon opts table (as JSON; Lua functions as {"$lua":"function"}) against schemas/rgx-addon.schema.json; flags contract-frozen tier4 keys that don't run yet |
rgx_audit_lua |
Scan a .lua file or addon directory for the unsafe patterns the framework prevents: raw C_Timer, manual OnEvent frames, SLASH_ globals, unguarded SetAttribute, secret-aura field comparisons, raw hook reassignment |
rgx_generate_addon |
Emit a contract-congruent addon Lua file using shipped keys |
rgx_get_contract |
Return the schema + shipped-surface reference for agent context |
-
rgx://schemas/addon— the annotated JSON Schema -
rgx://docs/declarative-api— the shipped declarative surface reference
From a framework source checkout:
cd /path/to/RGX-Framework/tools/rgx-mcp
npm ci --no-audit --no-fundRun the transition implementation only from a source checkout. RGX-Framework never publishes this fixture or any tooling archive. Public API/MCP/editor tooling belongs to RGX Studio.
Node.js 20 or newer is required.
Claude Code (.mcp.json or claude mcp add):
{
"mcpServers": {
"rgx": { "command": "node", "args": ["tools/rgx-mcp/src/server.js"] }
}
}Only the framework source checkout includes .mcp.json. The schema and API
reference are read from that checkout; set RGX_FRAMEWORK_PATH only to run
against a different framework tree. The published Framework addon contains no
MCP server. See Distribution.
tools/rgx-mcp/test/test-rgx-hello.mjs drives the real server over the real MCP client SDK against the real RGX-Hello repo — generate, validate, audit. If the reference addon drifts from the contract, the framework's own test fails. This loop has caught real shipped bugs (the declarative slider's suffix being silently dropped; the generator's hyphenated-name SavedVariables mismatch).
node test/test-rgx-hello.mjs /path/to/RGX-HelloSource: tools/rgx-mcp/.
Easy for humans to write is easy for agents to generate. RGXAddon is the
shared front door; the MCP must not invent a separate agent-only authoring
surface. When functionality ships, update the runtime, schema, declarative
docs, MCP validation/generation, and RGX-Hello coverage in the same change.