Skip to main content
Glama

SaaS Pro Max

Read api operation

read_api_operation
Read-onlyIdempotent

Run a read-only Management API operation discovered with get_api_capabilities. Supply its exact operationId and documented path, query and body parameters. Includes read-only POST queries. Current membership, scope, module and PII permissions still apply.

Input Schema

NameRequiredDescriptionDefault
bodyNoJSON request body matching the discovered bodySchema; omit for operations with no body
pathNoNamed path parameters, e.g. { app: 'orgSlug/appSlug', id: 'resource-id' }
queryNoNamed query parameters from the capability, including env for environment and repeated filter values
operationIdYesExact operationId returned by get_api_capabilities

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, idempotentHint, destructiveHint=false), but the description adds genuinely non-obvious context: read-only POST queries are permitted here, and membership, scope, module and PII permissions still gate execution. It does not describe error or failure behavior for unauthorized operations, which would complete the picture.

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?

Four tight sentences, each carrying distinct information: what it does, where the operation comes from, which parameters to supply, the POST caveat, and the permission gate. The core action is front-loaded with zero filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is an open-world proxy with no output schema, so the description carries the burden of explaining what comes back and how failures surface, and it does neither. Prerequisites and permission constraints are well covered, but an agent still cannot anticipate the response shape or error modes.

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%, so the baseline is 3; each parameter is already documented in the schema. The description only reinforces the source of the values ("exact operationId and documented path, query and body parameters") without adding format or validation guidance beyond what the schema states.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Run a read-only Management API operation") and ties it to the discovery tool, so an agent can tell it apart from get_api_capabilities. It never names the sibling execute_api_operation, which is the most likely confusion point for an agent choosing a tool.

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?

"discovered with get_api_capabilities" establishes a clear prerequisite and workflow ordering, and "read-only" plus "Includes read-only POST queries" scopes what belongs here. It stops short of explicitly routing write operations to execute_api_operation, leaving the when-not case to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources