Skip to main content
Glama

vivid-ads-commerce

vivid_fulfilment_order_status

Read-onlyIdempotent

Authoritative order state with a per-line-item breakdown and an order-level rollup. States: received, in_production, partially_ready, ready_for_pickup, dispatched, in_transit, out_for_delivery, delivered, completed, on_hold, cancelled. Includes the StarShipit shipping summary where available.

Input Schema

NameRequiredDescriptionDefault
tokenNoidentity token from vivid_identity_verify — REQUIRED to see any details. Without it a 6-digit code is emailed to customer_email and the tool returns need_verification.
order_idNoShopify order GID, e.g. gid://shopify/Order/123.
order_nameNoHuman order name, e.g. "#12345" (alias for order_id).
line_item_idNoOptional Shopify line item GID to scope to one item.
customer_emailYesThe email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / token
      Added value: +{
      +  "description": "identity token from vivid_identity_verify — REQUIRED to see any details. Without it a 6-digit code is emailed to customer_email and the tool returns need_verification.",
      +  "type": "string"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare the safety profile (readOnlyHint, idempotentHint, openWorldHint, destructiveHint=false). The description adds data-shape context: per-line-item breakdown, order-level rollup, and StarShipit shipping summary where available, plus the state vocabulary. It does not add permission, auth-flow, or rate-limit behavior beyond what annotations and schema already provide.

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 front-loaded with the core purpose, then compactly lists states and notes the shipping summary. Every sentence carries useful information for an agent, and there is no filler.

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 status tool with no output schema, the description adequately explains what data is returned and the possible states. The schema covers identity requirements fully, so the only meaningful gap is routing guidance among similar sibling status tools, which is minor given the rich schema and annotations.

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 the schema fully documents token, order_id, order_name, line_item_id, and customer_email. The description adds no parameter-level detail, so the baseline of 3 applies.

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 states a specific resource (authoritative order state) and the output shape (per-line-item breakdown plus order-level rollup), and enumerates all possible states. It is clear what the tool returns, but it does not explicitly distinguish this from siblings like vivid_order_status or vivid_fulfilment_pickup_status.

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 guidance, no alternatives named, and no prerequisites mentioned. The word 'Authoritative' hints at primacy but does not state when an agent should choose this tool over vivid_order_status or the other fulfilment status tools.

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