Skip to main content
Glama

list_api_keys

Read-onlyIdempotent

Audit Portkey API keys by retrieving details on access scopes, defaults, limits, expiration, and status. Use to monitor key configurations and enforce security policies.

Instructions

List Portkey API keys for auditing access, scopes, defaults, limits, and expiration. Use this for API keys only; use list_virtual_keys for provider keys. Returns total plus id, type, status, workspace/user scope, limits, defaults, alert emails, and creation mode.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
page_sizeNoNumber of results per page (max 100)
current_pageNoZero-based page number; the first page is 0
workspace_idNoFilter by workspace ID

Output Schema

TableJSON 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. Changed3 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
  2. 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"
  3. Addedv1.0.1
  4. Removed
  5. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=true) already fully disclose the safety profile, and the description is consistent with them. The description adds value beyond annotations by enumerating the return payload ('total plus id, type, status, workspace/user scope, limits, defaults, alert emails, and creation mode'), which is useful behavioral context. No annotation contradiction.

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 with zero waste. The purpose is front-loaded, followed by a one-sentence sibling disambiguation and a compact return summary. Every clause 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 zero required parameters, an output schema, and full annotation coverage, the definition is complete: annotations carry the safety profile, the schema documents pagination and filtering, and the description names the distinguishing sibling, summarizes the return shape, and states the use case. Nothing an agent needs to call it correctly is missing.

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%: page_size, current_page, and workspace_id each carry their own descriptions, so the baseline is 3. The description does not add parameter-level detail beyond what the schema already provides, though it implicitly hints at what workspace/user scope filters relate to via the return-field list.

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 Portkey API keys'. The intended purpose ('for auditing access, scopes, defaults, limits, and expiration') is concrete, and the description distinguishes itself from the sibling tool list_virtual_keys by scope ('Use this for API keys only'). An agent can tell exactly what this tool does without inspecting the schema.

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?

Explicitly routes the agent: 'Use this for API keys only; use list_virtual_keys for provider keys.' This names the alternative and the condition that selects it, leaving nothing to inference. The audit framing also communicates the appropriate use context for this tool versus the many other key-related siblings.

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