Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

MCP Server Setup

Orion includes an MCP (Model Context Protocol) server that lets AI assistants like Claude manage workflows, channels, and connectors through natural language. The MCP server wraps the Orion admin API, giving AI agents full control over your Orion instance.

Prerequisites

  • A running Orion instance (see CLI Setup)
  • An MCP-compatible client (Claude Code, Claude Desktop, or other MCP clients)

Configuration

Add the Orion MCP server to your MCP client configuration.

Claude Code: add to your .claude/settings.json or project-level .mcp.json:

{
  "mcpServers": {
    "orion": {
      "command": "orion-cli",
      "args": ["mcp", "serve"],
      "env": {
        "ORION_SERVER_URL": "http://localhost:8080"
      }
    }
  }
}

Claude Desktop: add to your Claude Desktop configuration file:

{
  "mcpServers": {
    "orion": {
      "command": "orion-cli",
      "args": ["mcp", "serve"],
      "env": {
        "ORION_SERVER_URL": "http://localhost:8080"
      }
    }
  }
}

If admin authentication is enabled on your Orion instance, include the API key:

{
  "env": {
    "ORION_SERVER_URL": "http://localhost:8080",
    "ORION_API_KEY": "your-secret-key"
  }
}

Available Tools

The MCP server exposes the following tools to AI assistants:

ToolDescription
list_workflowsList all workflows with optional status/tag filters
create_workflowCreate a new workflow (as draft)
get_workflowGet workflow details by ID
update_workflowUpdate a draft workflow
activate_workflowActivate a draft workflow
archive_workflowArchive a workflow
test_workflowDry-run a workflow with sample data
validate_workflowValidate workflow structure
list_channelsList all channels
create_channelCreate a new channel
activate_channelActivate a draft channel
list_connectorsList connectors (secrets masked)
create_connectorCreate a new connector
engine_statusGet engine status
reload_engineHot-reload the engine
health_checkCheck Orion health

Usage Example

Once configured, you can use natural language to manage Orion:

“Create a workflow that parses incoming orders, flags any over $10,000, and adds a risk level field. Then create a channel called ‘orders’ that uses it.”

The AI assistant will use the MCP tools to:

  1. Create the workflow via create_workflow
  2. Test it with sample data via test_workflow
  3. Activate it via activate_workflow
  4. Create the channel via create_channel
  5. Activate the channel via activate_channel

Troubleshooting

MCP server not connecting:

  • Verify Orion is running: curl http://localhost:8080/health
  • Check the ORION_SERVER_URL environment variable is set correctly
  • Ensure orion-cli is in your PATH

Authentication errors:

  • Verify ORION_API_KEY matches your Orion instance’s admin_auth.api_key
  • Check that admin auth is enabled on the Orion instance if you’re passing a key