Skip to main content
Glama

update_mcp_integration

DestructiveIdempotent

Modify an existing MCP integration's URL, auth, transport, headers, name, or secret mappings. Only supplied fields change, so inspect the integration first to avoid breaking active clients.

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. Changed2 schema fields changedv0.12.2
    • removedInput schema / properties / secret_mappings / items / properties / secret_key / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / secret_mappings / items / properties / secret_key / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. 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"
      +}
  3. 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"
      +}
  4. Addedv1.0.1

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is carried. The description still adds material context beyond them: 'Only supplied fields change' clarifies patch semantics, and 'URL, auth, header, and secret changes apply immediately and can break active clients' explains specifically which mutations are risky and why. It stops short of naming required permissions or rollback behavior, so it is strong but not exhaustive.

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 load-bearing: what can change, how the update behaves and what it can break, and which sibling to use instead. The riskiest information (immediate, can break clients) is placed before the alternative routing, and nothing is repeated from the schema.

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 a full output schema and complete annotation coverage, the description supplies everything an agent needs beyond structured fields: partial-update semantics, immediate-application risk, a mandatory pre-read step, and sibling routing. No explanatory burden is left unaddressed.

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 baseline is 3. The description earns above baseline by naming the updatable field groups in the same order an agent would encounter them and by stating the partial-update rule ('Only supplied fields change'), which is a semantic constraint the schema alone does not express. It adds no format details for the nested secret_mappings or configurations objects, which the schema already documents.

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 (Update) and resource (MCP integration) and enumerates exactly which fields are mutable: name, description, URL, auth, transport, headers, and Secret Reference mappings. It also explicitly separates itself from the sibling update_mcp_server, so an agent can distinguish the two targets without opening either schema.

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?

Gives an explicit prerequisite ('inspect get_mcp_integration first') and an explicit alternative with its selecting condition ('Use update_mcp_server when changing only a Portkey server instance's display metadata'). Both when-to-use and when-to-use-something-else are covered.

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