Skip to content
Try for free
On this page

Commands

Workflow MCP servers

Serve deployed workflows as tools for Model Context Protocol (MCP) clients.

These servers expose Sim workflows. To connect a server that provides external tools, use MCP servers.

These commands accept the global options.

Servers

List workflow MCP servers

OAuth login or personal API key required.

Code
sim workflow-mcp-servers list [options]

Options

OptionRequiredDescription
--sort-by <value>NoField used to sort the result. Do not rely on case-insensitive ordering when sorting by name. Defaults to "createdAt". Accepted values: name, createdAt, updatedAt.
--sort-order <value>NoSort direction. Defaults to "desc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

API request and response schemas: listWorkflowMcpServers.

Get workflow MCP server

OAuth login or personal API key required.

Code
sim workflow-mcp-servers get <serverId>

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

API request and response schemas: getWorkflowMcpServer.

Create workflow MCP server

OAuth login or personal API key required.

Code
sim workflow-mcp-servers create [options]

Options

OptionRequiredDescription
--name <value>YesServer display name, shown to connecting MCP clients.
--description <value>NoOptional server description.
--is-publicNoWhether the server accepts MCP clients without a Sim API key. Defaults to false; a public server lets anyone holding its URL execute the workflows it exposes.
--no-is-publicNoSend --is-public as false.
--workflow <value...>NoDeployed workflows to expose as MCP tools on the new server. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: createWorkflowMcpServer.

Update workflow MCP server

OAuth login or personal API key required.

Code
sim workflow-mcp-servers update <serverId> [options]

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

Options

OptionRequiredDescription
--name <value>NoServer display name, shown to connecting MCP clients.
--description <value>NoNew server description, or null to clear it. (--description null sends the word, not JSON null).
--is-publicNoWhether the server answers MCP clients without a Sim API key.
--no-is-publicNoSend --is-public as false.

API request and response schemas: updateWorkflowMcpServer.

Workflow tools

List workflow MCP tools

OAuth login or personal API key required.

Code
sim workflow-mcp-servers tools list <serverId>

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

API request and response schemas: listWorkflowMcpTools.

Deploy workflow as MCP tool

OAuth login or personal API key required.

Code
sim workflow-mcp-servers tools create <serverId> [options]

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

Options

OptionRequiredDescription
--workflow-id <value>YesWorkflow to expose as an MCP tool. It must already be deployed.
--tool-name <value>NoName MCP clients call. Normalized to the MCP tool-name grammar, and derived from the workflow name when omitted.
--tool-description <value>NoDescription shown to MCP clients. Derived from the workflow name when omitted.
--parameter-descriptions <json|@file>NoPer-field description overrides applied to the schema generated from the deployed workflow inputs, as [{"name":"email","description":"Customer email address"}]. A name matching no input field is ignored (JSON, or @path / @- to read a file or stdin).

API request and response schemas: deployWorkflowMcpTool.

Undeploy workflow MCP tool

OAuth login or personal API key required.

This withdraws the tool, and any agent calling it loses access.

Code
sim workflow-mcp-servers tools delete <serverId> <workflowId> [options]

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.
workflowIdYesWorkflow registered as an MCP tool on this server.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

API request and response schemas: undeployWorkflowMcpTool.

Delete servers

Delete workflow MCP server

OAuth login or personal API key required.

This deletes the MCP server, and any agent calling its tools loses access.

Code
sim workflow-mcp-servers delete <serverId> [options]

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

API request and response schemas: deleteWorkflowMcpServer.

Related docs

Was this helpful?
Suggest an edit