Skip to main content
Glama

update_integration

DestructiveIdempotent

Update an integration by slug, changing its name, credentials, provider config, secret mappings, pricing adjustments, or tags; only supplied fields are modified.

Instructions

Update an integration's name, description, API key, provider config, Secret Reference mappings, pricing adjustments, or tags by slug. Only provided fields change; tags replaces the whole map and null clears it; key, secret mapping, and config changes take effect immediately and can disrupt dependent providers or live requests, while pricing multipliers change cost analytics and budget accounting. Review get_integration first. Model availability and workspace access remain separate in update_integration_models and update_integration_workspaces.

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": {
      "slug": "<slug>"
    },
    "name": "update_integration"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyNoNew API key for the provider
nameNoNew human-readable name for the integration
slugYesThe slug of the integration to update
tagsNoReplacement integration tags, or null to clear all tags
aws_regionNoNew AWS region (for AWS Bedrock)
api_versionNoNew API version (for Azure OpenAI)
custom_hostNoNew custom base URL for the provider
descriptionNoNew description for the integration
resource_nameNoNew resource name (for Azure OpenAI)
vertex_regionNoNew GCP region (for Vertex AI)
deployment_nameNoNew deployment name (for Azure OpenAI)
secret_mappingsNoReplacement runtime Secret Reference mappings; each target_field must be unique
aws_access_key_idNoNew AWS access key ID (for AWS Bedrock)
vertex_project_idNoNew GCP project ID (for Vertex AI)
pricing_adjustmentsNoReplacement cost multiplier configuration, or null to clear adjustments
aws_secret_access_keyNoNew AWS secret access key (for AWS Bedrock)

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.13.0
    • addedInput schema / properties / tags
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Replacement integration tags, or null to clear all tags"
      +}
  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. Changed2 schema fields changed
    • addedInput schema / properties / pricing_adjustments
      Added value: +{
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "multiplier": {
      +          "description": "Per-unit multipliers applied over Portkey catalog pricing",
      +          "properties": {
      +            "additional_units": {
      +              "anyOf": [
      +                {
      +                  "additionalProperties": {
      +                    "anyOf": [
      +                      {
      +                        "minimum": 0,
      +                        "type": "number"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "propertyNames": {
      +                    "type": "string"
      +                  },
      +                  "type": "object"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Multipliers keyed by Portkey pricing unit, such as web_search or file_search"
      +            },
      +            "cache_read_audio_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read audio input token price multiplier"
      +            },
      +            "cache_read_image_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read image input token price multiplier"
      +            },
      +            "cache_read_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read input token price multiplier"
      +            },
      +            "cache_read_text_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-read text input token price multiplier"
      +            },
      +            "cache_write_image_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-write image input token price multiplier"
      +            },
      +            "cache_write_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-write input token price multiplier"
      +            },
      +            "cache_write_text_input_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Cache-write text input token price multiplier"
      +            },
      +            "default": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Fallback multiplier for pricing units; 1 is unchanged, 0.8 is a 20% discount"
      +            },
      +            "image": {
      +              "anyOf": [
      +                {
      +                  "properties": {
      +                    "default": {
      +                      "anyOf": [
      +                        {
      +                          "minimum": 0,
      +                          "type": "number"
      +                        },
      +                        {
      +                          "type": "null"
      +                        }
      +                      ],
      +                      "description": "Default image-generation price multiplier"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Image-generation pricing multipliers"
      +            },
      +            "prediction_accepted_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Accepted predicted-output token price multiplier"
      +            },
      +            "prediction_rejected_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Rejected predicted-output token price multiplier"
      +            },
      +            "reasoning_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Reasoning token price multiplier"
      +            },
      +            "request_audio_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Audio input token price multiplier"
      +            },
      +            "request_image_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Image input token price multiplier"
      +            },
      +            "request_text_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Text input token price multiplier"
      +            },
      +            "request_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Input token price multiplier"
      +            },
      +            "response_audio_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Audio output token price multiplier"
      +            },
      +            "response_image_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Image output token price multiplier"
      +            },
      +            "response_text_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Text output token price multiplier"
      +            },
      +            "response_token": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ],
      +              "description": "Output token price multiplier"
      +            }
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Replacement cost multiplier configuration, or null to clear adjustments"
      +}
    • 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 the workspace",
      +        "type": "string"
      +      },
      +      "target_field": {
      +        "description": "Integration field populated at runtime: key or configurations.<field>",
      +        "type": "string"
      +      },
      +      "value_format": {
      +        "anyOf": [
      +          {
      +            "enum": [
      +              "string",
      +              "json"
      +            ],
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "Treat the resolved value as a plain string or parsed JSON"
      +      }
      +    },
      +    "required": [
      +      "target_field",
      +      "secret_reference_id"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  6. Addedv1.0.1
  7. Removed
  8. First observed

TDQS

A4.6/5.0
Behavior4/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 real substance on top: partial-update semantics ("Only provided fields change"), whole-map replacement and null-clears semantics for tags, and the fact that key/secret/config changes apply immediately and can disrupt live requests. The only meaningful gap is that it never states required permissions or error behavior for that disruption risk.

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?

The blast-radius warning is front-loaded in the first sentence and the routing advice closes the text, so the agent gets the risky facts first. It is dense but nearly every clause carries information; the second sentence is a long multi-clause run that could be split for faster scanning.

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 16-parameter mutation tool this covers what matters: it is annotated as destructive, the schema fully describes each parameter, and an output schema exists, so the description need not explain return values. The description fills the remaining gaps — partial update behavior, immediate-effect disruption, and coverage boundaries — leaving nothing essential to an agent about to call it.

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 coverage is 100%, so the baseline is 3, but the description goes beyond restating fields by explaining the replacement semantics of tags ("tags replaces the whole map and null clears it") and grouping the provider-config fields by their blast radius. It stops short of clarifying interactions between overlapping parameters such as key versus secret_mappings, so it stops at 4.

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?

It names a specific verb (update) and enumerates the concrete resources affected — name, description, API key, provider config, Secret Reference mappings, pricing adjustments, tags — all keyed by slug. It also explicitly carves out model availability and workspace access as belonging to sibling tools, so an agent can distinguish it from update_integration_models and update_integration_workspaces without opening a 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?

It states a prerequisite ("Review get_integration first") and names the two alternative tools for the cases this tool does not cover. That is explicit when-to-use, when-not-to-use, and which-alternative guidance in one sentence.

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