Skip to main content
Glama

ShopsBuilder — AI Store Builder

Fetch orders

orders
Read-onlyIdempotent

Fetch list of orders from ShopsBuilder GraphQL API.

This tool retrieves the list of orders. For each order it returns information such as: ID, number, status, creation date, last update date, payment status, total amount, shipping and billing address country, order lines which include: quantity, product SKU, variant name, product ID, product name, unit price. placedVia is "AI agent ()" for orders a shopper's AI agent placed through the shop's UCP endpoint, and null for orders placed in the storefront.

Args: ctx (Context): The tool execution context. first (int | None): Number of orders to fetch (max 100 per request). after (str | None): Cursor for pagination - fetch orders after this cursor. sort_by (OrderSortingInput | None): Sort orders by specific field. filter (OrderFilterInput | None): Filter and search orders by specific criteria.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "orders"
  }
}

Input Schema

NameRequiredDescriptionDefault
afterNoCursor for pagination - fetch orders after this cursor
firstNoNumber of orders to fetch (max 100 per request)
filterNoFilter and search orders by specific criteria
sort_byNoSort orders by specific field

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuine domain context beyond that: it explains what `placedVia` means ('AI agent (<agent>)' for UCP-placed orders, null otherwise), which an agent cannot infer from the schema. It omits pagination end-state behavior (whether a next cursor is returned) and any rate-limit notes.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose statement is correctly front-loaded, but the Args section duplicates the already-complete schema, and the long enumeration of returned fields is largely redundant given an output schema exists. Roughly a third of the text earns its place; the rest repeats structured data.

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

Completeness4/5

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

For a read-only, zero-required-parameter list tool with full schema coverage, an output schema, and complete annotations, the description supplies enough to call it correctly. The main missing piece is pagination mechanics (how to continue past the last page), which matters for a fetch-list tool.

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 baseline is 3. The Args block restates the schema descriptions almost verbatim ('Number of orders to fetch (max 100 per request)', 'Cursor for pagination') without adding format examples, cursor provenance, or guidance on combining sort_by with filter. It also lists `ctx`, which is not an input-schema property, adding slight noise.

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 opens with a specific verb and resource ('Fetch list of orders from ShopsBuilder GraphQL API') and then enumerates exactly which order fields come back, so an agent knows precisely what the tool returns. It stops short of contrasting itself with any sibling (e.g. customers), but no order-listing alternative is named in the catalog, so the gap is minor.

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?

There is no when-to-use or when-not-to-use guidance — nothing about when an agent should page through orders versus query a single order or a customer's order history. The only operational hint ('max 100 per request') is a parameter constraint, not selection guidance.

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