Skip to main content

Connect coding agents to Orbis Studio

Connect external coding agents and AI assistants to your Orbis Studio instance so they can invoke your flows as tools — all over MCP.

This page is about connecting external agents to Orbis Studio over its MCP server endpoint. It is different from Orbis Studio's other MCP options:

How it works​

Every Orbis Studio project runs its own MCP server at:


_10
https://<your-orbis-server>/api/v1/mcp/project/<PROJECT_ID>/streamable

Any MCP-compatible coding agent or desktop AI assistant can connect to this URL with an Orbis Studio API key and immediately access your flows as callable tools.

Prerequisites​

  • A running Orbis Studio instance
  • An Orbis Studio API key
  • At least one project with flows that have a Chat Output component

Connect Claude Code​

Claude Code is a terminal-based AI coding agent from Anthropic. You can connect it to your Orbis Studio MCP server so it can invoke your flows as tools.

  1. Find your Project ID — open the project in Orbis Studio and copy the ID from the URL: .../projects/<PROJECT_ID>/...

  2. Get your Orbis Studio API key from Settings → API Keys.

  3. Register the Orbis Studio MCP server with Claude Code:


_10
claude mcp add orbis-studio \
_10
--transport streamable-http \
_10
--url "https://<your-orbis-server>/api/v1/mcp/project/<PROJECT_ID>/streamable" \
_10
--header "x-api-key: <your-api-key>"

Or add it manually to ~/.claude.json:


_11
{
_11
"mcpServers": {
_11
"orbis-studio": {
_11
"type": "streamable-http",
_11
"url": "https://<your-orbis-server>/api/v1/mcp/project/<PROJECT_ID>/streamable",
_11
"headers": {
_11
"x-api-key": "<your-api-key>"
_11
}
_11
}
_11
}
_11
}

  1. Claude Code now has access to your Orbis Studio flows as tools and can invoke them by their tool name.

Connect Cursor, Windsurf, or other MCP clients​

Any MCP client that supports streamable HTTP or SSE transport can connect to Orbis Studio. The general configuration is:

FieldValue
Transportstreamable-http (preferred) or sse
URLhttps://<your-orbis-server>/api/v1/mcp/project/<PROJECT_​ID>/streamable
AuthenticationHeader: x-api-key: <your-api-key>

For clients that require a JSON configuration block:


_11
{
_11
"mcpServers": {
_11
"orbis-studio": {
_11
"type": "streamable-http",
_11
"url": "https://<your-orbis-server>/api/v1/mcp/project/<PROJECT_ID>/streamable",
_11
"headers": {
_11
"x-api-key": "<your-api-key>"
_11
}
_11
}
_11
}
_11
}

Control which flows are exposed​

By default, all flows in a project are exposed as MCP tools. To control which flows are available to external clients:

  1. In Orbis Studio, open the project and click the MCP Server tab, or click Share → MCP Server from within a flow.
  2. Click Edit Tools and toggle which flows are exposed.

For full details on managing your MCP server, see Use Orbis Studio as an MCP server.

See also​