Skip to main content
Glama

update_output_guardrail_workspace_exclusions

DestructiveIdempotent

Set workspace exclusions from organisation-wide output guardrails. Exclude or restore workspaces, with merge preserving unmentioned workspaces and override replacing prior states.

Instructions

Set workspace exclusions from organisation-wide output 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.

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": {
      "organisation_id": "<organisation_id>",
      "workspaces": "<workspaces>"
    },
    "name": "update_output_guardrail_workspace_exclusions"
  }
}

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

TDQS

A4.8/5.0
Behavior5/5

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

Beyond annotations the description discloses immediate enforcement, the merge-vs-replace state semantics, that repeated states are safe, the organisation service API key requirement with organisation_exclusions.update scope, and Enterprise gating with a 403 failure mode on non-Enterprise plans.

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?

Dense and front-loaded: purpose first, then semantics, then prerequisite, then auth/gating. Minor redundancy between 'Enterprise-gated' and 'Returns 403 on non-Enterprise Portkey plans', which say nearly the same thing.

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?

With annotations, a full schema, and an output schema already present, the description covers everything else an agent needs: destructive immediate effect, merge semantics, idempotency, prerequisite listing step, and auth/plan requirements.

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 parameters are already documented; nevertheless the description adds real meaning by explaining what override_existing does to previously set states and by clarifying that each entry excludes or restores one workspace.

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 and resource ('Set workspace exclusions from organisation-wide output guardrails'), and explicitly frames itself against the matching list tool ('Review the matching list tool first'), which also disambiguates it from the input-guardrail sibling.

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?

Gives an explicit prerequisite ('review the matching list tool first because enforcement changes immediately'), explains the two modes (override_existing replaces prior states vs default merge preserves unmentioned workspaces), and states the required credential scope.

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