Deploy Workflows as MCP

Deploy your workflows as MCP tools to make them accessible to external AI assistants like Claude Desktop, Cursor, and other MCP-compatible clients. This turns your workflows into callable tools that can be invoked from anywhere.

Creating and Managing MCP Servers

MCP servers group your workflow tools together. Create and manage them in workspace settings:

1. Navigate to Settings → MCP Servers

2. Click Add
3. Enter a name and optional description
4. Choose access: API Key (private, requires X-API-Key header) or Public (no authentication)
5. Optionally select deployed workflows to add as tools immediately

6. Click Add Server
7. Click Details to view the MCP server

8. Copy the server URL for use in your MCP clients
9. View and manage all tools added to the server

Adding a Workflow as a Tool

Once your workflow is deployed, you can expose it as an MCP tool:

1. Open your deployed workflow
2. Click Deploy and go to the MCP tab

3. Configure the tool name and description
4. Add descriptions for each parameter (helps AI understand inputs)
5. Select which MCP servers to add it to
6. Click Save Tool

Tool Configuration

Tool Name

Use lowercase letters, numbers, and underscores. The name should be descriptive and follow MCP naming conventions (e.g., search_documents, send_email).

Description

Write a clear description of what the tool does. This helps AI assistants understand when to use the tool.

Parameters

Your workflow's input format fields become tool parameters. Add descriptions to each parameter to help AI assistants provide correct values.

Connecting MCP Clients

Sim generates a ready-to-paste configuration for every supported client. To get it:

1. Navigate to Settings → MCP Servers
2. Click Details on your server
3. Under MCP Client, select your client — Cursor, Claude Code, Claude Desktop, VS Code, or Sim
4. Copy the configuration, replacing $SIM_API_KEY with your Sim API key

Cursor

Cursor supports direct URL configuration. Add to your Cursor MCP settings (.cursor/mcp.json):

{
  "mcpServers": {
    "my-sim-workflows": {
      "url": "YOUR_SERVER_URL",
      "headers": { "X-API-Key": "$SIM_API_KEY" }
    }
  }
}

Cursor also provides a one-click install button in the server detail view.

Claude Code

Run this command in your terminal:

claude mcp add "my-sim-workflows" --url "YOUR_SERVER_URL" --header "X-API-Key:$SIM_API_KEY"

Claude Desktop

Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "my-sim-workflows": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "YOUR_SERVER_URL", "--header", "X-API-Key:$SIM_API_KEY"]
    }
  }
}

VS Code

Add to your VS Code MCP settings (.vscode/mcp.json):

{
  "mcpServers": {
    "my-sim-workflows": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "YOUR_SERVER_URL", "--header", "X-API-Key:$SIM_API_KEY"]
    }
  }
}

Server Management

From the server detail view in Settings → MCP Servers, you can:

• View tools: See all workflows added to a server
• Copy URL: Get the server URL for MCP clients
• Add workflows: Add more deployed workflows as tools
• Remove tools: Remove workflows from the server
• Delete server: Remove the entire server and all its tools

How It Works

When an MCP client calls your tool:

1. The request is received at your MCP server URL
2. Sim validates the request and maps parameters to workflow inputs
3. The deployed workflow executes with the provided inputs
4. Results are returned to the MCP client

Workflows execute using the same deployment version as API calls, ensuring consistent behavior.

Permission Requirements