Announced shipments
list_shipmentsYour announced shipments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | ||
| api_key | No | Your hm_... key. Only needed if your MCP client cannot send the "Authorization: Bearer" header. |
list_shipmentsYour announced shipments.
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | ||
| api_key | No | Your hm_... key. Only needed if your MCP client cannot send the "Authorization: Bearer" header. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds nothing beyond that — no mention of what shipments are returned, whether results are scoped to the authenticated account, or any ordering/pagination behavior.
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?
It is short, but the brevity comes from under-specification rather than efficiency — a single fragment that carries no actionable content. There is no front-loaded scope or filter explanation.
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?
With no output schema and a 50%-covered two-parameter schema, the description should explain the status filter and result scope. It does neither, leaving the agent to guess how this list tool behaves relative to the many other list_* siblings.
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 50%; the status enum has no description and the description does not explain what each status means or that omitting it returns all statuses. The api_key parameter is documented in the schema only, so the free-text description contributes no parameter meaning.
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?
The description 'Your announced shipments.' merely restates the tool title 'Announced shipments' without a verb or scope statement. It also sits ambiguously against the status enum (announced/arrived/cancelled), so an agent cannot tell whether this lists only announced shipments or all shipments.
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?
No guidance on when to use this versus siblings such as get_request, list_requests, or announce_shipment. The word 'announced' in the description actually conflicts with the status filter's three values, leaving the agent to infer filtering semantics.
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.