Radzor Component Spec (RCS) v1.0.0

1. Install the CLI

No install needed — npx downloads and runs it directly from npm. Or install globally for faster access:

# Run directly (no install)
$ npx radzor@latest add <component>

# Or install globally
$ npm install -g radzor

# Or as a dev dependency
$ npm install -D radzor

Requires Node.js 18+

2. Add a component

$ npx radzor@latest add audio-capture

✓ @radzor/audio-capture@0.1.0
  components/radzor/audio-capture/src/index.ts
  components/radzor/audio-capture/radzor.manifest.json
✓ Done! 2 files added.

3. Point your LLM at the manifest

"Use the radzor.manifest.json in components/radzor/audio-capture/
to add voice recording to my app."

The manifest tells your LLM exactly what inputs, outputs, actions, and events the component exposes — no documentation hunting required.

4. Set up AI agent integration

$ npx radzor@latest init

✓ Created radzor.json
✓ Created CLAUDE.md (Claude Code)
✓ Created .cursorrules (Cursor)
✓ Created .windsurfrules (Windsurf)
✓ Created .github/copilot-instructions.md (GitHub Copilot)
✓ Created .clinerules (Cline)
  Configuring MCP server for supported IDEs...
✓ Created .cursor/mcp.json (Cursor)
✓ Created .vscode/mcp.json (VS Code (Copilot))
  Registry created (no components installed yet)

This generates context files so your AI coding agent automatically discovers Radzor components and reads their manifests. Learn more →

5. Connect the MCP server

The Radzor MCP server gives your LLM direct access to all component manifests, composability data, and wiring patterns. Works with any MCP-compatible IDE.

# radzor init creates MCP config automatically, or add manually:
# .cursor/mcp.json or .vscode/mcp.json
{
  "mcpServers": {
    "radzor": {
      "command": "npx",
      "args": ["-y", "@radzor/mcp"]
    }
  }
}

Supported: Claude Desktop, Cursor, Windsurf, VS Code (Copilot), OpenCode

6. Build a pipeline

Chain components together — each manifest's composability.connectsTo tells you what connects where.

7. Other commands

$ npx radzor@latest list            # List all available components
$ npx radzor@latest init            # Set up config + AI agent files
$ npx radzor@latest add --no-deps   # Skip installing npm dependencies
$ npx radzor@latest graph           # Display data-flow graph of installed components
$ npx radzor@latest graph --mermaid # Export as Mermaid diagram syntax
$ npx radzor@latest validate        # Validate a radzor.manifest.json
$ npx radzor@latest create my-comp  # Scaffold a new component

Output connections

Pass a component's output data into another component's input. Use mapField to extract a specific field from a complex output.

"composability": {
  "connectsTo": [{
    "output": "audioStream",
    "compatibleWith": [
      "@radzor/speech-to-text.input.audioStream",
      "@radzor/audio-visualizer.input.audioStream"
    ]
  }]
}

Event connections

React to a component's events by triggering another component's action. Use the event key instead of output and target an action path.

"composability": {
  "connectsTo": [{
    "event": "onPaymentSuccess",
    "description": "Trigger notification when payment completes",
    "compatibleWith": [
      "@radzor/email-sender.action.send.body",
      "@radzor/webhook-receiver.action.trigger.payload"
    ]
  }]
}