Deployments.ai Docs
Command reference

deployments extension

Custom MCP and callback tools

CommandSummary
deployments extension createRegister an extension tool
deployments extension listList extension tools
deployments extension showShow an extension tool
deployments extension updateUpdate an extension tool
deployments extension archiveArchive an extension tool

deployments extension create

Register an extension tool.

deployments extension create --name <name> --description <description> --effect <effect> --execution <json> --input-schema <json> --scopes <json> --default-action <default-action>
  • Calls POST /v1/extensions (SDK createExtensionTool).
  • 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
--descriptionstringyesExtension tool description
--effectstringyesread, write, or execute
--executionstring (json)yesMCP or callback execution binding
--input-schemastring (json)yesJSON input schema
--providerstringProvider key
--scopesstring (json)yesRequired scopes
--default-actionstringyesallow, require_approval, or deny
--callback-secretstringCallback bearer secret (prefer env or file source)
--callback-secret-envstringEnvironment variable containing the callback bearer secret
--callback-secret-filestringFile containing the callback bearer secret

Also accepts the global flags.

deployments extension list

List extension tools.

deployments extension list
  • Calls GET /v1/extensions (SDK listExtensionTools).
  • 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 extension show

Show an extension tool.

deployments extension show --name <name>
FlagTypeRequiredDefaultDescription
--namestringyesTool name

Also accepts the global flags.

deployments extension update

Update an extension tool.

deployments extension update --name <name> --expected-version <number>
  • Calls PATCH /v1/extensions/{toolName} (SDK updateExtensionTool).
  • 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
--namestringyesTool name
--expected-versionstring (number)yesExpected resource version
--descriptionstringResource description
--effectstringread, write, or execute
--executionstring (json)MCP or callback execution binding
--input-schemastring (json)JSON input schema
--providerstringProvider key
--scopesstring (json)Required scopes
--default-actionstringallow, require_approval, or deny
--callback-secretstringReplacement callback bearer secret (prefer env or file source)
--callback-secret-envstringEnvironment variable containing the replacement callback bearer secret
--callback-secret-filestringFile containing the replacement callback bearer secret

Also accepts the global flags.

deployments extension archive

Archive an extension tool.

deployments extension archive --name <name>
  • Calls DELETE /v1/extensions/{toolName} (SDK archiveExtensionTool).
  • 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
--namestringyesTool name

Also accepts the global flags.

On this page