Get order
shipcloud_get_orderOne order by id, with delivery address and line items. GET /orders/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | Yes | The id shipcloud returned. |
shipcloud_get_orderOne order by id, with delivery address and line items. GET /orders/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | Yes | The id shipcloud returned. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered by structured data. The description adds almost nothing beyond the annotated behavior — no mention of error/not-found handling, authentication, or whether the response is live vs cached. The only extra content is the endpoint path and the shape of returned fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, front-loaded fragments with zero padding. The endpoint path is arguably redundant with the tool identity, but it costs little and clarifies the underlying resource. Efficient overall.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter read tool with full schema coverage and safety annotations, the description is adequate but thin: it names the returned fields yet omits what an agent may need — behavior on unknown ids, and whether nested line items are paginated or truncated. No output schema exists, so the description carries some return-value burden and only partly discharges it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the order_id parameter is described in the schema ('The id shipcloud returned'), so baseline is 3. The description restates 'by id' without adding format, source, or error semantics beyond the schema's pattern constraint.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (get) and resource (order) with scope detail: 'One order by id, with delivery address and line items.' This distinguishes it cleanly from shipcloud_list_orders (plural list) and from siblings like shipcloud_get_shipment/address. The REST endpoint reference reinforces the mapping.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The singular 'one order by id' implies when to use it versus the list sibling, but no alternative is named and no prerequisites or when-not conditions are given. Usage is inferable rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.