Skip to main content
Glama
jorgeortega

openapi-agentify

by jorgeortega
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get an order

getOrder
Read-onlyIdempotent

Retrieves a single order by ID, returning customer email, items, total, status, and creation date; use it to inspect order details or verify payment or refund status.

Instructions

Gets one order by its id: customer email, items (sku, qty, priceCents), totalCents, status (open, paid or refunded) and createdAt. Returns the API's 404 when there's no such order; use listOrders to find ids. Calls need the Orders API key (x-api-key header; the demo's is demo-customer-key-0001); without it the tool returns the API's 401.

Input Schema

NameRequiredDescriptionDefault
idYesThe order's id, such as ord_1002, as listOrders returns it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only declare the read-only/idempotent profile, so the description adds real value: required auth (x-api-key header), the concrete demo key, the exact 401 failure mode without it, and the 404 behavior for unknown ids. That is more than an agent could infer from annotations alone.

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?

Three dense sentences ordered by importance: what it returns, then failure modes, then auth. The demo API key is mildly incidental detail, but it is tied directly to the 401 sentence and earns its place for a sandbox environment.

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?

No output schema exists, yet the description enumerates the return payload fields and status enum values, and covers both the 404 and 401 paths plus the auth prerequisite. An agent has everything needed to call this correctly and interpret failures.

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 coverage is 100% and the schema itself documents the id format (ord_1002, as listOrders returns it), so the description's mention of id adds no new syntax or constraints. Baseline 3 applies since the schema carries the parameter burden.

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?

Names a specific verb and resource ('Gets one order by its id') and enumerates the returned fields (customer email, items, totalCents, status, createdAt), which makes it unmistakably distinct from the sibling listOrders that returns many orders.

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?

Explicitly routes the agent to listOrders when it needs to discover ids, and states the 404 outcome for missing orders. It stops short of a full when-to-use/when-not matrix, but the boundary with listOrders is clear.

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