Skip to main content
Glama

list_orders

Read-onlyIdempotent

List recent order records for the project, PII-FREE — customer name, e-mail, phone and billing/shipping addresses are never returned. Use this to find orders and spot ones that failed to sync. To spot sync problems, pass errors_only:true to see only orders that failed or were not inserted. Optional connection_id restricts to one order connection; limit caps the result (default 50, max 200). Returns {orders:[{orderId, channelOrderId, channelOrderName, storeOrderId, connectionId, channelCode, marketplaceCode, status, syncStatus, createdAt}], total}. syncStatus flags which orders failed ('error'/'not_inserted'); to see WHICH sync step failed, when and why, pass orderId as order_id to list_order_commands. connectionId of an order from a marketplace INTEGRATION (marketplaceCode set) is not a standalone order connection: get_order_connection / get_order_overview do not know it and answer 404 — that does NOT mean the connection is broken or deleted. For those orders use list_marketplaces (match marketplaceCode/channelCode), marketplace_status (orderStats) and sync_marketplace_orders. project_id is OPTIONAL (project_id_required otherwise — then call list_projects).

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": "list_orders"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMax records (default 50, max 200).
project_idNo
errors_onlyNoOnly orders that failed to sync / were not inserted.
connection_idNoRestrict to one order connection (from get_order_overview).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover read-only/idempotent/non-destructive, but the description adds substantial behavior the agent could not otherwise know: PII fields are never returned, the limit default and max, the response envelope, and the important caveat that a marketplace-order connectionId yields 404 from get_order_connection without meaning the connection is broken.

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?

Information is front-loaded (purpose, PII guarantee, then the errors_only path, then the connectionId caveat). It is dense and slightly overstuffed — limit defaults and the marketplace fallback chain could be trimmed — but nearly every sentence carries distinct, actionable content.

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, so the description supplies the return shape ({orders:[...], total}) and the meaning of syncStatus values. Combined with the routing caveats and the optional-project_id behavior, an agent has everything needed to call this correctly without trial and error.

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 75%, and the description still adds meaning for each parameter: connection_id scopes to one order connection, errors_only filters to failed/not-inserted orders, limit caps results, and project_id's optionality with the project_id_required fallback is explained. It does not repeat schema formatting details, but the optional-project behavior is genuinely new information.

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 (list recent order records for the project) plus a distinguishing property (PII-FREE, naming the exact fields never returned). It is clearly separable from siblings like list_order_commands and get_order_overview, which it names.

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 explicit when-to-use (find orders, spot failed syncs) and the exact parameter that triggers the narrower case (errors_only:true). It also routes to alternatives: list_order_commands for which sync step failed, and list_marketplaces / marketplace_status / sync_marketplace_orders for marketplace-integration orders.

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