Deployments.ai Docs
Command reference

deployments mcp-server

Remote MCP servers

CommandSummary
deployments mcp-server createRegister an MCP server
deployments mcp-server listList MCP servers
deployments mcp-server showShow an MCP server
deployments mcp-server updateUpdate an MCP server
deployments mcp-server discoverVerify and discover MCP tools
deployments mcp-server archiveArchive an MCP server

deployments mcp-server create

Register an MCP server.

deployments mcp-server create --name <name> --endpoint-origin <endpoint-origin> --endpoint-path <endpoint-path> --tools <json>
  • Calls POST /v1/mcp-servers (SDK createMcpServer).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--namestringyesResource name
--endpoint-originstringyesHTTPS endpoint origin
--endpoint-pathstringyesEndpoint path
--toolsstring (json)yesRemote tool allowlist
--authstringMCP authentication JSON (prefer env or file source)
--auth-envstringEnvironment variable containing MCP authentication JSON
--auth-filestringFile containing MCP authentication JSON

Also accepts the global flags.

deployments mcp-server list

List MCP servers.

deployments mcp-server list
  • Calls GET /v1/mcp-servers (SDK listMcpServers).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments mcp-server show

Show an MCP server.

deployments mcp-server show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments mcp-server update

Update an MCP server.

deployments mcp-server update <id> --expected-version <number>
  • Calls PATCH /v1/mcp-servers/{id} (SDK updateMcpServer).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected resource version
--namestringNew server name
--endpoint-originstringNew HTTPS endpoint origin
--endpoint-pathstringNew endpoint path
--toolsstring (json)Remote tool allowlist
--authstringReplacement MCP authentication JSON (prefer env or file source)
--auth-envstringEnvironment variable containing replacement MCP authentication JSON
--auth-filestringFile containing replacement MCP authentication JSON

Also accepts the global flags.

deployments mcp-server discover

Verify and discover MCP tools.

deployments mcp-server discover <id>
  • Calls POST /v1/mcp-servers/{id}/discover (SDK discoverMcpServer).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments mcp-server archive

Archive an MCP server.

deployments mcp-server archive <id>
  • Calls DELETE /v1/mcp-servers/{id} (SDK archiveMcpServer).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--reasonstringReason for this operation

Also accepts the global flags.

On this page