Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

update_guardrail

Modify a guardrail's name, checks, or actions to create a new version that takes effect immediately for dependent configs. Review list_guardrails first, then update by ID or slug.

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.

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
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. Changed1 schema field changedv1.0.11
    • addedInput schema / properties / guardrail_id / minLength
      Added value: +1
  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.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."
  4. Addedv1.0.1
  5. Removed
  6. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Adds genuinely non-obvious behavior beyond the annotations: updating mints a new version that takes effect immediately for dependent configs, and the response carries id, slug, and version_id. It does not say whether omitted fields (or omitted array entries in checks) are preserved or dropped — material for a non-idempotent tool whose arrays have minItems 1.

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, zero filler: the first establishes identity and contrasts siblings, the second front-loads the immediate side effect before the precondition. Every clause carries information.

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 annotations, a rich nested schema, and an output schema, the description covers the key risk (immediate effect on dependent configs) and the return shape. The remaining gap is merge/replace semantics for partially specified checks and actions, which an agent needs before calling.

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 nested checks/actions objects are documented in detail in the schema, so the baseline applies. The description only names the three mutable field groups and adds no format or merge semantics beyond the schema.

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 exact mutable fields (name, checks, actions) and explicitly contrasts with create_guardrail and delete_guardrail. An agent can distinguish it from every guardrail sibling 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 Guidelines4/5

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

Names the alternative write operations and excludes them ('unlike create_guardrail ... or delete_guardrail'), and advises reviewing list_guardrails before mutating. It stops short of stating when this tool is the right choice versus a narrower sibling like replace_guardrail_mcp_servers, but the routing guidance is clear.

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