Workflow MCP Servers

Every command below also accepts the global options.

Create workflow MCP server

sim workflow-mcp-servers create [options]

Create Workflow MCP Server (OAuth login or personal API key required)

Options

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

Delete workflow MCP server

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

Delete Workflow MCP Server (OAuth login or personal API key required)

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

Publish workflow as MCP tool

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

Publish Workflow As MCP Tool (OAuth login or personal API key required)

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

Options

OptionRequiredDescription
--workflow-id <value>YesDeployed workflow to publish. The workflow 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).

List workflow MCP tools

sim workflow-mcp-servers tools list <serverId>

List Workflow MCP Tools (OAuth login or personal API key required)

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

Unpublish workflow MCP tool

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

Unpublish Workflow MCP Tool (OAuth login or personal API key required)

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.
workflowIdYesWorkflow published as a tool on this server.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

Get workflow MCP server

sim workflow-mcp-servers get <serverId>

Get Workflow MCP Server (OAuth login or personal API key required)

Arguments

ArgumentRequiredDescription
serverIdYesUnique workflow-MCP server identifier.

List workflow MCP servers

sim workflow-mcp-servers list [options]

List Workflow MCP Servers (OAuth login or personal API key required)

Options

OptionRequiredDescription
--sort-by <value>NoField used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt.
--sort-order <value>NoSort direction. Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

Update workflow MCP server

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

Update Workflow MCP Server (OAuth login or personal API key required)

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.