Skip to main content
Glama

update_input_guardrail_workspace_exclusions

DestructiveIdempotent

Set or restore workspace exclusions for organisation-wide input guardrails. Exclude or re-enforce enforcement per workspace, with optional override to replace existing states.

Instructions

Set workspace exclusions from organisation-wide input guardrails. Each entry excludes or restores one workspace; override_existing replaces prior states while the default merge behavior preserves unmentioned workspaces. Review the matching list tool first because enforcement changes immediately. Repeating the same states is safe. Requires an organisation service API key with organisation_exclusions.update scope. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

NameRequiredDescriptionDefault
workspacesYesWorkspace exclusion states to apply
organisation_idYesOrganisation ID whose workspace exclusions should be updated
override_existingNoReplace existing exclusion states instead of merging changes

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. 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"
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well past the annotations: immediate enforcement effect, merge-vs-replace semantics with explicit statement that unmentioned workspaces are preserved by default, idempotency confirmed ('repeating the same states is safe'), required API key scope, Enterprise gating and the 403 failure mode. This is exactly the context destructiveHint=true cannot convey on its own.

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?

Front-loaded with the action, then merge semantics, then the list-first caution, then auth/gating. Dense but nearly all load-bearing; 'Enterprise-gated' and 'Returns 403 on non-Enterprise Portkey plans' partially restate the same constraint.

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?

An output schema exists so return values need no explanation, and the description still covers preconditions (scope, Enterprise plan), side effects (immediate enforcement), safe-retry behavior, and state-merge semantics for a destructive mutation.

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; the description still adds real meaning by explaining that override_existing replaces prior states while the default merges, which is the highest-risk parameter behavior. It also clarifies the per-entry polarity (exclude or restore), which the schema only covers at field level.

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: set workspace exclusions from organisation-wide *input* guardrails. The 'input' qualifier separates it from update_output_guardrail_workspace_exclusions, and the framing separates it from the read-only list_input_guardrail_workspace_exclusions sibling.

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?

Tells the agent to review the matching list tool first because enforcement changes immediately, which is concrete sequencing guidance tied to a named sibling. It doesn't spell out when to prefer override_existing vs merge as a decision rule, but the effect of each is stated clearly enough to choose.

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