Skip to main content
Glama

orders_list

Read-onlyIdempotent

List ecommerce orders filtered by status, payment status, or creation date. Optionally include customer personal data for operator workflows.

Instructions

List ecommerce orders (GET /admin/api/ecommerce/v1/orders). Read-only. Optional filters: status (e.g. 'created', 'cancelled'), payment_status (e.g. 'paid', 'unpaid'), created_after (ISO8601), created_before (ISO8601). include_pii=false (default) strips customer email / name / address / phone / IP via whitelist; set include_pii=true for operator workflows that need the full payload.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYes
statusNoOrder status filter (q.order.status.$eq).
payment_statusNoPayment status filter (q.order.payment_status.$eq).
created_afterNoISO8601 timestamp; orders created at or after (q.order.created_at.$gteq).
created_beforeNoISO8601 timestamp; orders created at or before (q.order.created_at.$lteq).
include_piiNoDefault false (strips PII via whitelist). Set true to keep customer email / name / address / phone in the response.
Behavior4/5

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

The description explicitly states the tool is read-only, aligns with annotations (readOnlyHint, idempotentHint), and details the PII whitelist behavior. It adds value beyond annotations by explaining parameter-driven behavior.

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?

The description is a single, well-organized paragraph that front-loads the core purpose and read-only status, followed by concise parameter details. No extraneous content.

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?

Given the tool's complexity (multiple filters, PII handling) but no output schema, the description adequately covers key behaviors. It lacks pagination details, but that is a minor gap for a listing tool.

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 high (83%), but the description adds examples (e.g., 'created', 'cancelled') and explains the effect of include_pii. This provides practical guidance not available in the schema alone.

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?

The description clearly states the tool lists ecommerce orders, specifies the endpoint (GET /admin/api/ecommerce/v1/orders), and enumerates optional filters. It distinguishes itself from other order-related tools like order_get by listing filtering capabilities.

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?

The description provides clear context on when to use this tool (listing orders with optional filters) and explains the include_pii parameter for different workflows. It doesn't explicitly state when not to use it, but the sibling tool 'order_get' implies a distinction.

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/runnel/voog-mcp'

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