Skip to content
Try for free
On this page

Commands

MCP servers

Connect external Model Context Protocol (MCP) servers so workflows can use their tools.

To serve Sim workflows to MCP clients instead, use workflow MCP servers.

sim mcp-servers is also spelled sim mcp-server.

These commands accept the global options.

Server connections

List MCP servers

Code
sim mcp-servers list [options]

Options

OptionRequiredDescription
--search <value>NoCase-insensitive substring match against the server name.
--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: listMcpServers.

Get MCP server

Code
sim mcp-servers get <mcpServerId>

Arguments

ArgumentRequiredDescription
mcpServerIdYesUnique MCP server identifier.

API request and response schemas: getMcpServer.

Create MCP server

Code
sim mcp-servers create [options]

Options

OptionRequiredDescription
--name <value>YesServer display name.
--description <value>NoOptional server description.
--transport <value>NoTransport protocol. Defaults to streamable-http on creation. Accepted values: streamable-http.
--url <value>YesAbsolute HTTP or HTTPS endpoint URL without {{ENV_VAR}} references. It determines server identity and is immutable: delete and recreate the server to change endpoints.
--auth-type <value>NoAuthentication method. On creation, omission without headers probes once: an OAuth challenge selects oauth, an unauthenticated success selects none, and other outcomes fall back to headers. An OAuth client ID selects oauth when the method is omitted. Set explicitly to use headers with a server advertising OAuth; adding headers later does not change the saved method. Accepted values: none, headers, oauth.
--headers <json|@file>NoWrite-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin).
--timeout <value>NoPer-request timeout in milliseconds. Defaults to 30000 on creation.
--retries <value>NoNumber of retries per request. Defaults to 3 on creation.
--enabledNoWhether workflows can use the server's tools. Defaults to true on creation.
--no-enabledNoSend --enabled as false.
--oauth-client-id <value>NoPre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization.
--oauth-client-secret <value>NoWrite-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null).

API request and response schemas: createMcpServer.

Update MCP server

Code
sim mcp-servers update <mcpServerId> [options]

Arguments

ArgumentRequiredDescription
mcpServerIdYesUnique MCP server identifier.

Options

OptionRequiredDescription
--name <value>NoServer display name.
--description <value>NoOptional server description.
--transport <value>NoTransport protocol. Defaults to streamable-http on creation. Accepted values: streamable-http.
--url <value>NoImmutable server URL. When provided, it must equal the current URL; use delete and create to change endpoints.
--auth-type <value>NoAuthentication method. On creation, omission without headers probes once: an OAuth challenge selects oauth, an unauthenticated success selects none, and other outcomes fall back to headers. An OAuth client ID selects oauth when the method is omitted. Set explicitly to use headers with a server advertising OAuth; adding headers later does not change the saved method. Accepted values: none, headers, oauth.
--headers <json|@file>NoWrite-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin).
--timeout <value>NoPer-request timeout in milliseconds. Defaults to 30000 on creation.
--retries <value>NoNumber of retries per request. Defaults to 3 on creation.
--enabledNoWhether workflows can use the server's tools. Defaults to true on creation.
--no-enabledNoSend --enabled as false.
--oauth-client-id <value>NoPre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization.
--oauth-client-secret <value>NoWrite-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null).

API request and response schemas: updateMcpServer.

Tool discovery

List MCP server tools

OAuth login or personal API key required.

Code
sim mcp-servers tools list <mcpServerId> [options]

Arguments

ArgumentRequiredDescription
mcpServerIdYesUnique MCP server identifier.

Options

OptionRequiredDescription
--refreshNoRefresh tools using your credentials. Otherwise results may reuse another workspace member's recent discovery and omit newly added tools.
--no-refreshNoSend --refresh as false.

API request and response schemas: listMcpServerTools.

Remove servers

Delete MCP server

This removes the MCP server and the tools it provides.

Code
sim mcp-servers delete <mcpServerId> [options]

Arguments

ArgumentRequiredDescription
mcpServerIdYesUnique MCP server identifier.

Options

OptionRequiredDescription
-y, --yesYesConfirm this operation.

API request and response schemas: deleteMcpServer.

Related docs

Was this helpful?
Suggest an edit