Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_guardrails

Read-onlyIdempotent

Retrieve guardrails with IDs, slugs, status, and ownership, filtered by workspace or organization, to find the identifiers needed before viewing, updating, or deleting a guardrail.

Instructions

List guardrails in the org with id, slug, status, ownership, and optional workspace/org filters. Use this to find IDs and slugs before get_guardrail, update_guardrail, or delete_guardrail.

Input Schema

NameRequiredDescriptionDefault
page_sizeNoNumber of items per page (1-100, default: 100)
current_pageNoZero-based page number; the first page is 0
workspace_idNoFilter guardrails by workspace ID
organisation_idNoFilter guardrails by organization ID

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. Changed5 schema fields changedv0.11.5
    • changedInput schema / properties / current_page / description
      Previous value: -"Page number for pagination"New value: +"Zero-based page number; the first page is 0"
    • removedInput schema / properties / current_page / exclusiveMinimum
      Removed value: -0
    • addedInput schema / properties / current_page / minimum
      Added value: +0
    • addedInput schema / properties / page_size / exclusiveMinimum
      Added value: +0
    • removedInput schema / properties / page_size / minimum
      Removed value: -1
  3. Changed3 schema fields changedv0.5.0
    • addedInput schema / properties / current_page / maximum
      Added value: +9007199254740991
    • changedInput schema / properties / current_page / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / page_size / type
      Previous value: -"number"New value: +"integer"
  4. Changed2 schema fields changedv1.0.2
    • changedInput schema / properties / page_size / description
      Previous value: -"Number of items per page (1-1000, default: 100)"New value: +"Number of items per page (1-100, default: 100)"
    • changedInput schema / properties / page_size / maximum
      Previous value: -1000New value: +100
  5. Addedv1.0.1
  6. Removed
  7. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds only that the workspace/org filters are optional and what fields come back — both also available via schema and output schema. It does not mention pagination behavior or default page size, which would have been genuinely additive.

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 capability statement comes first, the invocation guidance second, and every clause (returned fields, optional filters, downstream tools) earns its place.

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?

For a read-only list tool with a full output schema, complete parameter descriptions, and unambiguous annotations, nothing more is required. The description supplies the one thing structured fields cannot: why an agent would call this before the guardrail mutation tools.

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%, including page_size range and zero-based paging, so the schema carries the parameter burden. The description reiterates only that workspace/org filters are optional, adding no syntax, format, or precedence detail beyond the schema. Baseline 3 applies.

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 ('List guardrails in the org') and enumerates the fields returned (id, slug, status, ownership) plus the filter surface. An agent can immediately tell this is the enumeration tool rather than a single-resource fetch like get_guardrail.

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?

The second sentence gives explicit routing guidance: use this to resolve IDs/slugs before get_guardrail, update_guardrail, or delete_guardrail. It lacks an explicit when-not clause (e.g. what to do if you already hold an ID, or how to handle large result sets), so it stops just short of a 5.

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