Skip to main content
Glama
jorgeortega

openapi-agentify

by jorgeortega
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List orders

listOrders
Read-onlyIdempotent

Retrieves orders oldest first, optionally filtered by status, with cursor-based paging. Use it to find an order ID before fetching full details.

Instructions

Lists orders, oldest first, optionally filtered by status, 20 per page unless limit says otherwise. Use it to find an order's id before calling getOrder. Returns { orders, nextCursor }; pass nextCursor back as cursor for the next page (null on the last one). 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
limitNoHow many orders to return, 1 to 100 (default 20).
cursorNoWhere to continue from: the cursor the previous page returned (nextCursor). Leave it out for the first page.
statusNoOnly orders with this status. One of: open, paid, refunded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.1
    • addedInput schema / properties / cursor / description
      Added value: +"Where to continue from: the cursor the previous page returned (nextCursor). Leave it out for the first page."
    • changedInput schema / properties / limit / description
      Previous value: -"Page size."New value: +"How many orders to return, 1 to 100 (default 20)."
    • addedInput schema / properties / status / description
      Added value: +"Only orders with this status. One of: open, paid, refunded."
  2. First observedv0.1.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), yet the description still adds real value: default ordering, default page size of 20, the exact return shape, pagination termination (null cursor), and the auth requirement including 401 behavior. The only omission is what happens with an invalid cursor or status, which is minor.

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?

Three sentences, front-loaded with purpose and scope, then pagination mechanics, then auth. No restatement of the name or title and no filler; even the demo key serves a concrete calling need.

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?

With no output schema, the description compensates by spelling out the returned { orders, nextCursor } shape and how to consume it. Auth, defaults, and ordering are all covered, so an agent can call this correctly on the first attempt.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds cross-parameter meaning by tying cursor to the nextCursor return value and restating the 20-per-page default that limit overrides. It stops short of describing the status enum values, which the schema already covers.

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 (lists orders) plus the sort order and filter capability. It also explicitly distinguishes itself from the sibling getOrder by framing itself as the id-lookup step that precedes it.

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?

Gives a concrete when-to-use rule: 'Use it to find an order's id before calling getOrder,' which tells the agent the prerequisite relationship with the sibling. Pagination usage is also prescribed (pass nextCursor back as cursor), leaving nothing to inference.

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