Skip to main content
Glama

swagger-petstore---openapi-3.0.getOrderById

Read-onlyIdempotent

Look up a purchase order by ID to retrieve its details and current status.

Instructions

Find purchase order by ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNoResponse from the tool
Behavior2/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 description does not need to cover safety. However, it also adds no extra behavioral details (e.g., error handling, authentication, or uniqueness of orders). Unlike the calibration example, it doesn't add any constraint or clarification beyond what the annotations provide.

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?

The description is a single, focused sentence that is immediately understandable and front-loaded. It is concise without unnecessary words, though it could potentially mention the specific API context to be more helpful without hurting brevity.

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?

Given the tool has no parameters and an output schema exists, the description is mostly adequate. However, it doesn't mention that this is for the 'store' endpoint or that an order ID must be provided (even though no params are listed). For a trivial getter, this is borderline sufficient, but a bit more context could improve completeness.

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?

There are 0 parameters and schema coverage is 100%, so the baseline is 4. The description doesn't need to elaborate on parameters, and it doesn't add confusion. A score of 4 is appropriate as there is no parameter information to expand upon.

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?

The description 'Find purchase order by ID' uses a clear verb and resource, accurately conveying its purpose. However, it doesn't explicitly distinguish itself from the sibling 'petstore-api.getOrderById' tool, so it earns a 4 rather than a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives, such as the similar getOrderById in the petstore-api group. There are no prerequisites, exclusions, or context on how it fits into the broader API workflow.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mirajmahmudul/agentdevx-sdk'

If you have feedback or need assistance with the MCP directory API, please join our Discord server