Skip to main content
Glama

update_mcp_integration

DestructiveIdempotent

Updates an MCP integration’s URL, auth, headers, tags, or secret mappings; changes apply immediately, so inspect the integration before altering connectivity-related fields.

Instructions

Update an MCP integration's name, description, tags, 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.

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": {
      "id": "<id>"
    },
    "name": "update_mcp_integration"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe MCP integration ID or slug to update
urlNoNew URL endpoint
nameNoNew display name
tagsNoKey-value tags. Replaces existing tags; pass null to clear. Keys allow letters, numbers, underscores, and hyphens
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

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. Changed1 schema field changedv0.16.4
    • addedInput schema / properties / tags
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "propertyNames": {
      +        "pattern": "^[a-zA-Z0-9_-]+$",
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Key-value tags. Replaces existing tags; pass null to clear. Keys allow letters, numbers, underscores, and hyphens"
      +}
  3. 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"
  4. 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"
      +]
  5. 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"
      +}
  6. 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"
      +}
  7. Addedv1.0.1

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds the consequences an agent actually needs: URL, auth, header, and secret changes take effect immediately and can break live clients, and unspecified fields are preserved. That is concrete risk and effect disclosure beyond the structured safety flags.

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 with zero filler, ordered so the scope and immediate-effect warning land before the sibling routing hint. The field list is compact and serves the purpose statement rather than padding it.

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 10-parameter mutation tool with nested objects, the description covers scope, patch semantics, risk of immediate application, and the correct alternative, while the rich schema and output schema handle parameter and return detail. Nothing an agent needs in order to call it safely is missing.

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% and the schema already documents replacement semantics, null-clearing for tags, the custom_headers-to-configurations.custom_headers routing, and the uniqueness constraint on target_field. The description's field enumeration largely restates the schema rather than adding new meaning, 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 ('Update') plus the resource ('an MCP integration') and enumerates the mutable fields, so an agent knows exactly what surface it touches. It also explicitly names the sibling it is not ('update_mcp_server') and the conditions that select that sibling, making the distinction resolvable 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 patch-semantics rule ('Only supplied fields change'), a mandatory prerequisite ('inspect get_mcp_integration first'), and a named alternative with its selecting condition ('Use update_mcp_server when changing only a Portkey server instance's display metadata'). When-to-use, when-to-check-first, and which-alternative are all 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