Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

update_mcp_integration

DestructiveIdempotent

Update an MCP integration's name, description, URL, auth, transport, headers, or secret mappings. Only supplied fields change; URL/auth/header changes apply immediately, so inspect first.

Instructions

Update an MCP integration's name, description, URL, auth, transport, headers, or runtime Secret Reference mappings. Only supplied fields change; URL, auth, header, and secret changes apply immediately and can break active clients, so inspect get_mcp_integration first. Use update_mcp_server when changing only a Portkey server instance's display metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe MCP integration ID or slug to update
urlNoNew URL endpoint
nameNoNew display name
auth_typeNoNew authentication type. Current examples are 'none', 'headers' (custom headers), and 'oauth_auto' (OAuth); Portkey may accept additional values.
transportNoNew transport protocol
descriptionNoNew description
configurationsNoReplacement documented or forward-compatible configuration fields. configurations.custom_headers must be a string-to-string header map when present.
custom_headersNoNew custom headers for authentication. Sent via configurations.custom_headers
secret_mappingsNoReplacement runtime Secret Reference mappings; each target_field must be unique

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.11.5
    • changedInput schema / properties / auth_type / description
      Previous value: -"New authentication type"New value: +"New authentication type. Current examples are 'none', 'headers' (custom headers), and 'oauth_auto' (OAuth); Portkey may accept additional values."
    • removedInput schema / properties / auth_type / enum
      Removed value: -[
-  "oauth_auto",
-  "headers",
-  "none"
-]
    • addedInput schema / properties / auth_type / minLength
      Added value: +1
    • addedInput schema / properties / configurations
      Added value: +{
+  "additionalProperties": {},
+  "description": "Replacement documented or forward-compatible configuration fields. configurations.custom_headers must be a string-to-string header map when present.",
+  "propertyNames": {
+    "type": "string"
+  },
+  "type": "object"
+}
  2. Changed1 schema field changed
    • addedInput schema / properties / secret_mappings
      Added value: +{
+  "description": "Replacement runtime Secret Reference mappings; each target_field must be unique",
+  "items": {
+    "properties": {
+      "secret_key": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Optional key to select from a multi-value secret"
+      },
+      "secret_reference_id": {
+        "description": "Secret Reference UUID or slug accessible to this integration",
+        "type": "string"
+      },
+      "target_field": {
+        "description": "Configuration field resolved at runtime, such as configurations.oauth_metadata",
+        "type": "string"
+      },
+      "value_format": {
+        "anyOf": [
+          {
+            "enum": [
+              "string",
+              "json"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Use json when the target configuration field expects a structured object"
+      }
+    },
+    "required": [
+      "target_field",
+      "secret_reference_id"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
  3. Addedv1.0.1

TDQS

A4.9/5.0
Behavior5/5

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

The description meaningfully extends the annotations. destructiveHint=true is just a flag, but the description explains the concrete danger: 'URL, auth, header, and secret changes apply immediately and can break active clients.' It also discloses the partial-update semantics ('Only supplied fields change') and the recommended pre-flight inspection, none of which are in the annotations or schema.

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

Conciseness5/5

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

Three sentences, each earning its place: sentence one states purpose and scope, sentence two states the risk and pre-requisite, sentence three routes to the sibling alternative. The most important safety information (immediate breakage) is front-loaded ahead of the sibling routing. No filler or repetition of schema content.

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 9-parameter mutation tool with nested objects, the description covers the decision-relevant ground: what fields are affected, patch behavior, immediate-apply risk, a pre-inspection step, and sibling differentiation. An output schema exists so return values need not be described, and annotations already carry idempotence/open-world traits. Nothing an agent needs to call this correctly is missing.

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

Parameters4/5

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

Schema description coverage is 100%, so the schema already documents each of the 9 parameters, setting a baseline of 3. The description adds one genuinely useful cross-cutting semantic: 'Only supplied fields change,' which clarifies that all parameters are optional patch operations, plus the risk profiling that groups URL/auth/header/secret changes as immediately effective. This exceeds the baseline without duplicating schema detail.

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 states a specific verb ('Update'), a specific resource ('an MCP integration'), and enumerates exactly which aspects change: name, description, URL, auth, transport, headers, or runtime Secret Reference mappings. It distinguishes itself from siblings like update_mcp_server, update_mcp_integration_capabilities, and update_mcp_integration_workspaces by delimiting its scope through the field list.

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?

The description gives explicit when-to-use context (changing any of the listed core configuration fields) and explicitly names the alternative: 'Use update_mcp_server when changing only a Portkey server instance's display metadata.' It also supplies a prerequisite ('inspect get_mcp_integration first'), which tells the agent what to do before invoking this tool.

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