Documentation

Get started with Orchestrix in your favorite AI-powered IDE.

Getting Started

Orchestrix provides AI-powered development agents through the MCP (Model Context Protocol). You can configure it with Claude Code or Cursor IDE in just a few steps.

Prerequisites: You'll need a license key to use Orchestrix.Sign up to get your license key, or log in to view your existing keys.

Installation

Orchestrix connects directly to our cloud server. No local dependencies required, always up-to-date.

Claude Code

Option 1: Command Line

claude mcp add --transport http orchestrix https://orchestrix-mcp.youlidao.ai/api/mcp \
  --header "Authorization: Bearer YOUR_LICENSE_KEY"

Option 2: Configuration File

Add to ~/.claude.json (global) or .mcp.json (project):

~/.claude.json
{
  "mcpServers": {
    "orchestrix": {
      "type": "http",
      "url": "https://orchestrix-mcp.youlidao.ai/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_LICENSE_KEY"
      }
    }
  }
}

Cursor

Edit ~/.cursor/mcp.json:

~/.cursor/mcp.json
{
  "mcpServers": {
    "orchestrix": {
      "url": "https://orchestrix-mcp.youlidao.ai/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_LICENSE_KEY"
      }
    }
  }
}

Project Setup

Install Orchestrix infrastructure (slash commands, tmux scripts, hooks) into your project.

Option 1: CLI Installer (Recommended)

Run this command in your project directory:

npx orchestrix install

This installs everything in one command:

  • .claude/commands/o.md, o-help.md, o-status.md — Slash Commands
  • .mcp.json — MCP Server configuration (merged with existing)
  • .orchestrix-core/core-config.yaml — Project configuration
  • .orchestrix-core/scripts/ — tmux automation scripts (Pro/Team)
  • .claude/settings.local.json — Claude Code hooks (Pro/Team)

Options: --key <KEY>, --offline, --force, --no-hooks, --no-scripts

After Installation: You must restart Claude Code (/exit then claude) for the new Slash Commands to be recognized.

Option 2: In-Session Installation (via Claude Code)

If you already have the MCP server connected, ask Claude directly:

Please call the orchestrix-init tool from the Orchestrix MCP server

Claude will call the orchestrix-init tool and create the files interactively.

Available Commands

After installation, these commands are available in Claude Code:

CommandDescription
/o [agent]Activate an agent (e.g., /o dev, /o sm)
/o-helpShow all available agents
/o-statusShow Orchestrix status

Usage

After configuration, restart Claude Code or Cursor to activate the MCP server.

Quick Start with Slash Commands

If you've installed the Slash Commands, simply type:

/o dev        # Activate Developer agent
/o sm         # Activate Scrum Master agent
/o qa         # Activate QA Engineer agent
/o architect  # Activate System Architect agent

Available Agents

AgentDescription
devFull Stack Developer
smScrum Master
qaQA Engineer
architectSystem Architect
analystBusiness Analyst
pmProduct Manager
poProduct Owner
ux-expertUX Expert

Troubleshooting

"Unknown slash command" after installation

Claude Code does not automatically reload Slash Commands. You must restart Claude Code:

/exit
claude

orchestrix-init tool not found

  • Make sure Orchestrix MCP Server is connected (check with /mcp)
  • Verify your license key is correct in the configuration
  • Try being more explicit: Please call the orchestrix-init tool from the Orchestrix MCP server

MCP server not connecting

  • Verify your license key is correct
  • Check that the configuration file is valid JSON
  • Restart your IDE after making changes

Learn More

For comprehensive guides, advanced usage, and detailed documentation, visit the Orchestrix Documentation.