portkey-admin-mcp

register_deployment

Registers a self-hosted Gateway deployment when onboarding a new control-plane target, returning one-time credentials to store securely immediately.

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.

Input Schema

Name	Required	Description
`name`	Yes	Deployment display name
`slug`	No	Optional deployment slug
`tags`	No	Deployment tags, or null to create without tags
`type`	No	Production or non-production deployment type
`is_default`	No	Make this the default deployment
`organisation_id`	No	Owning organisation UUID
`gateway_base_url`	No	Self-hosted Gateway base URL
`jwt_subs_allowed`	No	JWT subject values allowed to use the deployment
`deployment_config`	No	Gateway deployment configuration
`workspaces_allowed`	No	Workspace slugs this deployment may serve; empty allows all
`mcp_gateway_base_url`	No	MCP Gateway base URL
`is_dataservice_hosted`	No	Whether the deployment hosts its own data service
`jwt_sub_workspace_mapping`	No	JWT subject to workspace-slug mapping
`is_playground_proxy_allowed`	No	Whether Playground proxy traffic is allowed

Output Schema

Name	Required	Description
`ok`	Yes	Whether the tool call succeeded and returned structured data
`data`	No	Structured success payload when ok is true
`error`	No	Structured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv1.0.9Oct 26, 2026

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"

Changed1 schema field changedv0.12.2Oct 2, 2026

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"
+}

Addedv0.11.5Sep 8, 2026

TDQS

A4.3/5.0

Behavior5/5

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

Annotations only declare the generic write/idempotency profile, but the description adds three things an agent cannot infer: Enterprise-only gating, a 403 response on non-Enterprise plans, and that authentication/registry credentials are returned exactly once into the transcript and must be stored securely and never logged. That last point materially changes how the agent should handle the result.

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?

Front-loaded with the core action and alternative, then the security-critical credential warning, then the error mode. The only waste is the literal duplication of "Enterprise-gated." at both the start and end of the description, which repeats information already given.

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

Completeness4/5

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

Covers the behavior an agent most needs for a creating mutation: plan gating, failure mode, one-time secret exposure, and where to look for existing records; an output schema exists so return shape needs no explanation. It is slightly thin on mutation semantics such as what happens on duplicate registration and whether the deployment can be subsequently modified via update_deployment.

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 carries the field-level semantics (name, slug, tags, type, gateway_base_url, jwt_subs_allowed, deployment_config, etc.). The description adds no guidance on parameter interactions, required-vs-optional tradeoffs, or how deployment_config relates to gateway_base_url, so baseline 3 applies.

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?

States a specific verb and resource ("Register a self-hosted Gateway deployment") plus the triggering context (onboarding a new control-plane target), and explicitly names the sibling it is not for existing records (list_deployments). An agent can tell this apart from the read path without opening the schema.

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

Usage Guidelines4/5

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

Gives a clear when-to-use condition (onboarding a new control-plane target) and names an alternative for the read case (list_deployments), plus the Enterprise-plan gate with a concrete 403 failure mode. It does not distinguish itself from the closer siblings update_deployment or get_deployment, which is the remaining ambiguity.

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

Deploy Server