Skip to main content
Glama

register_deployment

Sets up a self-hosted Gateway deployment for a new control-plane target and returns one-time authentication and registry credentials to store securely.

Instructions

Enterprise-gated. Register a self-hosted Gateway deployment when onboarding a new control-plane target; use list_deployments for existing registrations. The response can contain authentication and registry credentials exactly once, exposed to this MCP transcript, so store them securely immediately and never log them. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "register_deployment"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesDeployment display name
slugNoOptional deployment slug
tagsNoDeployment tags, or null to create without tags
typeNoProduction or non-production deployment type
is_defaultNoMake this the default deployment
organisation_idNoOwning organisation UUID
gateway_base_urlNoSelf-hosted Gateway base URL
jwt_subs_allowedNoJWT subject values allowed to use the deployment
deployment_configNoGateway deployment configuration
workspaces_allowedNoWorkspace slugs this deployment may serve; empty allows all
mcp_gateway_base_urlNoMCP Gateway base URL
is_dataservice_hostedNoWhether the deployment hosts its own data service
jwt_sub_workspace_mappingNoJWT subject to workspace-slug mapping
is_playground_proxy_allowedNoWhether Playground proxy traffic is allowed

Output Schema

NameRequiredDescriptionDefault
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Changed1 schema field changedv0.12.2
    • addedInput schema / properties / tags
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "propertyNames": {
      +        "pattern": "^[a-zA-Z0-9_-]+$",
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Deployment tags, or null to create without tags"
      +}
  4. Addedv0.11.5

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations declare readOnly=false, destructive=false, idempotent=false, but the description adds what annotations cannot: the response may carry authentication and registry credentials exactly once, in the MCP transcript, which must be stored securely and never logged. It also discloses the 403 failure mode for non-Enterprise plans — rich context beyond the structured hints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Content is front-loaded with the purpose and the credential warning follows immediately. However, 'Enterprise-gated.' appears twice, and the 403 sentence restates gating — trimming the duplicate would tighten it without losing information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 14-parameter, non-idempotent mutation with a rich schema and an output schema, the description covers the things structured fields can't: enterprise eligibility, one-time credential exposure, and safe handling of the response. An agent has enough to call this correctly and handle the result safely.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% across all 14 parameters, so the schema already defines every field's meaning. The description adds nothing parameter-specific (e.g., how deployment_config or jwt_subs_allowed interact with registration), which is exactly the baseline-3 case.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ('Register a self-hosted Gateway deployment') plus the triggering scenario ('onboarding a new control-plane target'). It explicitly distinguishes itself from the read-side sibling by naming list_deployments for existing registrations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states when to use this tool (new control-plane target onboarding), names the alternative for a different case (list_deployments for existing registrations), and gives a hard eligibility constraint (Enterprise-only, 403 otherwise). Preconditions are explicit rather than inferred.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools