Skip to main content
Glama

update_guardrail

Destructive

Modify an existing guardrail's name, checks, or actions and immediately publish a new version for dependent configurations; review existing guardrails first.

Instructions

Update a guardrail's name, checks, or actions, unlike create_guardrail which registers a new one or delete_guardrail which removes it. This creates a new version that takes effect immediately for dependent configs, so review list_guardrails first; returns the updated id, slug, and version_id.

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": {
      "guardrail_id": "<guardrail_id>"
    },
    "name": "update_guardrail"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name for the guardrail
checksNoUpdated array of checks to apply
actionsNoUpdated actions configuration
guardrail_idYesThe guardrail UUID or slug to update

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 changedv1.0.11
    • addedInput schema / properties / guardrail_id / minLength
      Added value: +1
  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. Changed1 schema field changedv0.11.5
    • changedInput schema / properties / checks / items / properties / parameters / description
      Previous value: -"Check-specific configuration parameters"New value: +"Check-specific configuration. Supported examples include requestParametersCheck and parameters.forwardHeaders; forwarded headers can expose sensitive values, so allow only the minimum required names."
  5. Addedv1.0.1
  6. Removed
  7. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing that each update creates a new version that takes effect immediately for dependent configs — a non-obvious consequence consistent with destructiveHint=true and idempotentHint=false. Nothing in the description contradicts the declared safety profile.

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?

Two sentences, front-loaded with the action and the sibling contrast, then the side-effect warning and return shape. Density is high but every clause carries signal; the second sentence is a run-on packing three distinct facts.

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?

For a destructive, deeply nested mutation tool this covers the essentials: versioning semantics, immediate dependent impact, a pre-read recommendation, and the returned identifiers (even though an output schema exists). The notable gap is whether omitted fields are preserved or cleared — undefined for a partial-update tool with required-array semantics.

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%, so the baseline is 3; the description only restates the three updatable field names already documented in the schema and adds no format or sourcing detail beyond that. The sensitive-header caveat lives in the schema, not the description.

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 plus resource and enumerates the mutable fields ('name, checks, or actions'), then explicitly contrasts with create_guardrail and delete_guardrail. An agent can distinguish this from its closest siblings without opening any schema.

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

Usage Guidelines4/5

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

Explicitly names the two neighbouring lifecycle tools it is not, and adds a concrete prerequisite ('review list_guardrails first'). It stops short of stating when-not to use it (e.g. use the workspace-exclusion updaters instead), so it is clear context rather than a complete decision rule.

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