Skip to main content
Glama

Update an integration

update_integration
DestructiveIdempotent

Update an integration by ID. The fields and settings left out keep their current value, credentials included.

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

Input Schema

NameRequiredDescriptionDefault
appYesThe app key
nameNoIntegration name
settingsNoSettings specific to the integration app
integration_idYesID of the integration to update

Output Schema

NameRequiredDescriptionDefault
idNoIntegration ID
appNoIntegration app key
nameNoIntegration name
pausedNoIntegration paused status
settingsNoSettings specific to the integration app
created_atNoDate of creation for the entity
updated_atNoDate of last update for the entity

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / settings / anyOf
      Previous value: -[
      -  {
      -    "maxProperties": 0,
      -    "title": "Empty",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "members": {
      -        "description": "IDs of the organization members receiving the alerts",
      -        "examples": [
      -          [
      -            1,
      -            2
      -          ]
      -        ],
      -        "items": {
      -          "type": "integer"
      -        },
      -        "maxItems": 100,
      -        "minItems": 1,
      -        "type": "array"
      -      }
      -    },
      -    "title": "Email",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "integration_key": {
      -        "description": "ilert alert source integration key",
      -        "examples": [
      -          "il1api00000000000000000000000000000000000000"
      -        ],
      -        "maxLength": 70,
      -        "minLength": 40,
      -        "type": "string",
      -        "writeOnly": true
      -      }
      -    },
      -    "title": "ilert",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "access_token": {
      -        "description": "Ntfy access token used for authenticated topics, must start with `tk_`",
      -        "examples": [
      -          "tk_00000000000000000000000000000"
      -        ],
      -        "maxLength": 32,
      -        "minLength": 32,
      -        "type": [
      -          "string",
      -          "null"
      -        ],
      -        "writeOnly": true
      -      },
      -      "hostname": {
      -        "description": "Hostname of the Ntfy server",
      -        "examples": [
      -          "ntfy.sh"
      -        ],
      -        "maxLength": 100,
      -        "minLength": 4,
      -        "type": "string"
      -      },
      -      "topic": {
      -        "description": "Ntfy topic receiving the alerts",
      -        "examples": [
      -          "phare-alerts"
      -        ],
      -        "maxLength": 255,
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "title": "Ntfy",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "secret": {
      -        "description": "Secret used to sign the webhook requests",
      -        "examples": [
      -          "a-very-secure-secret"
      -        ],
      -        "maxLength": 250,
      -        "minLength": 10,
      -        "type": "string",
      -        "writeOnly": true
      -      },
      -      "url": {
      -        "description": "URL receiving the webhook requests",
      -        "examples": [
      -          "https://example.com/webhooks/phare"
      -        ],
      -        "format": "uri",
      -        "maxLength": 250,
      -        "type": "string"
      -      }
      -    },
      -    "title": "Outgoing Webhooks",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "api_key": {
      -        "description": "Pushover application API token",
      -        "examples": [
      -          "a00000000000000000000000000000"
      -        ],
      -        "maxLength": 30,
      -        "minLength": 30,
      -        "type": "string",
      -        "writeOnly": true
      -      },
      -      "user_key": {
      -        "description": "Pushover user or group key",
      -        "examples": [
      -          "u00000000000000000000000000000"
      -        ],
      -        "maxLength": 30,
      -        "minLength": 30,
      -        "type": "string",
      -        "writeOnly": true
      -      }
      -    },
      -    "title": "Pushover",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "members": {
      -        "description": "IDs of the organization members receiving the alerts",
      -        "examples": [
      -          [
      -            1,
      -            2
      -          ]
      -        ],
      -        "items": {
      -          "type": "integer"
      -        },
      -        "maxItems": 100,
      -        "minItems": 1,
      -        "type": "array"
      -      }
      -    },
      -    "title": "SMS",
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "maxProperties": 0,
      +    "title": "Empty",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "members": {
      +        "description": "IDs of the organization members receiving the alerts",
      +        "examples": [
      +          [
      +            1,
      +            2
      +          ]
      +        ],
      +        "items": {
      +          "type": "integer"
      +        },
      +        "maxItems": 100,
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "title": "Email",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "integration_key": {
      +        "description": "ilert alert source integration key. It is never returned, an update without it keeps the current key.",
      +        "examples": [
      +          "il1api00000000000000000000000000000000000000"
      +        ],
      +        "maxLength": 70,
      +        "minLength": 40,
      +        "type": "string",
      +        "writeOnly": true
      +      }
      +    },
      +    "title": "ilert",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "access_token": {
      +        "description": "Ntfy access token used for authenticated topics, must start with `tk_`. It is never returned, an update without it keeps the current token and null removes it.",
      +        "examples": [
      +          "tk_00000000000000000000000000000"
      +        ],
      +        "maxLength": 32,
      +        "minLength": 32,
      +        "type": [
      +          "string",
      +          "null"
      +        ],
      +        "writeOnly": true
      +      },
      +      "hostname": {
      +        "description": "Hostname of the Ntfy server",
      +        "examples": [
      +          "ntfy.sh"
      +        ],
      +        "maxLength": 100,
      +        "minLength": 4,
      +        "type": "string"
      +      },
      +      "topic": {
      +        "description": "Ntfy topic receiving the alerts",
      +        "examples": [
      +          "phare-alerts"
      +        ],
      +        "maxLength": 255,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "title": "Ntfy",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "secret": {
      +        "description": "Secret used to sign the webhook requests. It is never returned, an update without it keeps the current secret.",
      +        "examples": [
      +          "a-very-secure-secret"
      +        ],
      +        "maxLength": 250,
      +        "minLength": 10,
      +        "type": "string",
      +        "writeOnly": true
      +      },
      +      "url": {
      +        "description": "URL receiving the webhook requests",
      +        "examples": [
      +          "https://example.com/webhooks/phare"
      +        ],
      +        "format": "uri",
      +        "maxLength": 250,
      +        "type": "string"
      +      }
      +    },
      +    "title": "Outgoing Webhooks",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "api_key": {
      +        "description": "Pushover application API token. It is never returned, an update without it keeps the current token.",
      +        "examples": [
      +          "a00000000000000000000000000000"
      +        ],
      +        "maxLength": 30,
      +        "minLength": 30,
      +        "type": "string",
      +        "writeOnly": true
      +      },
      +      "user_key": {
      +        "description": "Pushover user or group key. It is never returned, an update without it keeps the current key.",
      +        "examples": [
      +          "u00000000000000000000000000000"
      +        ],
      +        "maxLength": 30,
      +        "minLength": 30,
      +        "type": "string",
      +        "writeOnly": true
      +      }
      +    },
      +    "title": "Pushover",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "members": {
      +        "description": "IDs of the organization members receiving the alerts",
      +        "examples": [
      +          [
      +            1,
      +            2
      +          ]
      +        ],
      +        "items": {
      +          "type": "integer"
      +        },
      +        "maxItems": 100,
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "title": "SMS",
      +    "type": "object"
      +  }
      +]
    • changedOutput schema / properties / settings / anyOf
      Previous value: -[
      -  {
      -    "title": "Empty",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "members": {
      -        "description": "IDs of the organization members receiving the alerts",
      -        "examples": [
      -          [
      -            1,
      -            2
      -          ]
      -        ],
      -        "items": {
      -          "type": "integer"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "title": "Email",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {},
      -    "title": "ilert",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "hostname": {
      -        "description": "Hostname of the Ntfy server",
      -        "examples": [
      -          "ntfy.sh"
      -        ],
      -        "type": "string"
      -      },
      -      "topic": {
      -        "description": "Ntfy topic receiving the alerts",
      -        "examples": [
      -          "phare-alerts"
      -        ],
      -        "type": "string"
      -      }
      -    },
      -    "title": "Ntfy",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "url": {
      -        "description": "URL receiving the webhook requests",
      -        "examples": [
      -          "https://example.com/webhooks/phare"
      -        ],
      -        "format": "uri",
      -        "type": "string"
      -      }
      -    },
      -    "title": "Outgoing Webhooks",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {},
      -    "title": "Pushover",
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "members": {
      -        "description": "IDs of the organization members receiving the alerts",
      -        "examples": [
      -          [
      -            1,
      -            2
      -          ]
      -        ],
      -        "items": {
      -          "type": "integer"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "title": "SMS",
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "title": "Empty",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "members": {
      +        "description": "IDs of the organization members receiving the alerts",
      +        "examples": [
      +          [
      +            1,
      +            2
      +          ]
      +        ],
      +        "items": {
      +          "type": "integer"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "title": "Email",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {},
      +    "title": "ilert",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "access_token_enabled": {
      +        "description": "Whether an access token is set",
      +        "examples": [
      +          true
      +        ],
      +        "readOnly": true,
      +        "type": "boolean"
      +      },
      +      "hostname": {
      +        "description": "Hostname of the Ntfy server",
      +        "examples": [
      +          "ntfy.sh"
      +        ],
      +        "type": "string"
      +      },
      +      "topic": {
      +        "description": "Ntfy topic receiving the alerts",
      +        "examples": [
      +          "phare-alerts"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "title": "Ntfy",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "url": {
      +        "description": "URL receiving the webhook requests",
      +        "examples": [
      +          "https://example.com/webhooks/phare"
      +        ],
      +        "format": "uri",
      +        "type": "string"
      +      }
      +    },
      +    "title": "Outgoing Webhooks",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {},
      +    "title": "Pushover",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "members": {
      +        "description": "IDs of the organization members receiving the alerts",
      +        "examples": [
      +          [
      +            1,
      +            2
      +          ]
      +        ],
      +        "items": {
      +          "type": "integer"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "title": "SMS",
      +    "type": "object"
      +  }
      +]
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "app": {
      +      "description": "Integration app key",
      +      "enum": [
      +        "sms",
      +        "discord",
      +        "email",
      +        "ilert",
      +        "ntfy",
      +        "outgoing_webhook",
      +        "pushover",
      +        "slack",
      +        "telegram"
      +      ],
      +      "type": "string"
      +    },
      +    "created_at": {
      +      "description": "Date of creation for the entity",
      +      "format": "date-time",
      +      "type": "string"
      +    },
      +    "id": {
      +      "description": "Integration ID",
      +      "examples": [
      +        1
      +      ],
      +      "type": "integer"
      +    },
      +    "name": {
      +      "description": "Integration name",
      +      "examples": [
      +        "DevOps Team"
      +      ],
      +      "type": "string"
      +    },
      +    "paused": {
      +      "description": "Integration paused status",
      +      "examples": [
      +        false
      +      ],
      +      "type": "boolean"
      +    },
      +    "settings": {
      +      "anyOf": [
      +        {
      +          "title": "Empty",
      +          "type": "object"
      +        },
      +        {
      +          "properties": {
      +            "members": {
      +              "description": "IDs of the organization members receiving the alerts",
      +              "examples": [
      +                [
      +                  1,
      +                  2
      +                ]
      +              ],
      +              "items": {
      +                "type": "integer"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "title": "Email",
      +          "type": "object"
      +        },
      +        {
      +          "properties": {},
      +          "title": "ilert",
      +          "type": "object"
      +        },
      +        {
      +          "properties": {
      +            "hostname": {
      +              "description": "Hostname of the Ntfy server",
      +              "examples": [
      +                "ntfy.sh"
      +              ],
      +              "type": "string"
      +            },
      +            "topic": {
      +              "description": "Ntfy topic receiving the alerts",
      +              "examples": [
      +                "phare-alerts"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "title": "Ntfy",
      +          "type": "object"
      +        },
      +        {
      +          "properties": {
      +            "url": {
      +              "description": "URL receiving the webhook requests",
      +              "examples": [
      +                "https://example.com/webhooks/phare"
      +              ],
      +              "format": "uri",
      +              "type": "string"
      +            }
      +          },
      +          "title": "Outgoing Webhooks",
      +          "type": "object"
      +        },
      +        {
      +          "properties": {},
      +          "title": "Pushover",
      +          "type": "object"
      +        },
      +        {
      +          "properties": {
      +            "members": {
      +              "description": "IDs of the organization members receiving the alerts",
      +              "examples": [
      +                [
      +                  1,
      +                  2
      +                ]
      +              ],
      +              "items": {
      +                "type": "integer"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "title": "SMS",
      +          "type": "object"
      +        }
      +      ],
      +      "description": "Settings specific to the integration app"
      +    },
      +    "updated_at": {
      +      "description": "Date of last update for the entity",
      +      "format": "date-time",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.9/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. The description adds non-obvious patch semantics—omitted fields and credentials keep their current values—which is useful behavioral context beyond the annotations, though permissions or failure behavior are not described.

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?

Two sentences, front-loaded with the core action and followed by the key mutation semantic. There is no unnecessary wording.

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?

With an output schema and rich per-field schema descriptions, the definition covers the essential behavior for a partial-update tool. It could mention permissions or that settings shape depends on app, but those are secondary given the schema detail.

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 schema already documents app, integration_id, and settings fields in detail. The description adds the general partial-update rule that omitted fields retain current values, which meaningfully supplements the schema, even though credential retention is also repeated in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: "Update an integration by ID." It is clearly distinct from create/get/delete siblings by the verb and resource name, but it does not explicitly contrast itself with alternatives.

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

Usage Guidelines3/5

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

Usage is implied by "Update an integration by ID," and the second sentence gives valuable partial-update context. However, there is no explicit when-to-use guidance versus create/delete/get, and no prerequisites or exclusions are stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources