Every command below also accepts the global options.
Create workflow MCP server
sim workflow-mcp-servers create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Server display name, shown to connecting MCP clients. |
--description <value> | No | Optional server description. |
--is-public | No | Whether 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-public | No | Send --is-public as false. |
--workflow <value...> | No | Deployed workflows to publish as tools on the new server. (space-separated, or @path / @- with one value per line). |
Delete workflow MCP server
sim workflow-mcp-servers delete <serverId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this destructive operation. |
Publish workflow as MCP tool
sim workflow-mcp-servers tools create <serverId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow-id <value> | Yes | Deployed workflow to publish. The workflow must already be deployed. |
--tool-name <value> | No | Name MCP clients call. Normalized to the MCP tool-name grammar, and derived from the workflow name when omitted. |
--tool-description <value> | No | Description shown to MCP clients. Derived from the workflow name when omitted. |
--parameter-descriptions <json|@file> | No | Per-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>Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
Unpublish workflow MCP tool
sim workflow-mcp-servers tools delete <serverId> <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
workflowId | Yes | Workflow published as a tool on this server. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this destructive operation. |
Get workflow MCP server
sim workflow-mcp-servers get <serverId>Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
List workflow MCP servers
sim workflow-mcp-servers list [options]Options
| Option | Required | Description |
|---|---|---|
--sort-by <value> | No | Field 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> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
Update workflow MCP server
sim workflow-mcp-servers update <serverId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Server display name, shown to connecting MCP clients. |
--description <value> | No | New server description, or null to clear it. (--description null sends the word, not JSON null). |
--is-public | No | Whether the server answers MCP clients without a Sim API key. |
--no-is-public | No | Send --is-public as false. |