List notes of a shipment
locate2u_list_shipment_notesList all notes on a shipment. Locate2u API: GET /shipments/{id}/notes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| shipment_id | Yes |
locate2u_list_shipment_notesList all notes on a shipment. Locate2u API: GET /shipments/{id}/notes.
| Name | Required | Description | Default |
|---|---|---|---|
| shipment_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds the underlying endpoint (GET /shipments/{id}/notes), but says nothing about ordering, pagination, or what a note object contains — details that matter for a list operation with no output schema.
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 sentences, zero filler, with the action front-loaded and the endpoint as supporting detail.
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 simple one-parameter read with no output schema, this is close to adequate, but the agent gets no sense of the return shape or result volume. A brief note on what a note record contains, or on pagination, would close the gap.
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 description coverage is 0%, so the description carries the burden, and it only implies that the single parameter is a shipment identifier via 'on a shipment'. Format and validity constraints (positive integer) are left entirely to the schema.
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 and resource ('List all notes on a shipment') and adds the exact API endpoint, so the operation is unambiguous. It is distinguishable from add_shipment_note by the verb, but it never explicitly contrasts itself with the near-identical sibling list_stop_notes.
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 list_stop_notes or add_shipment_note, and no prerequisites or exclusions stated. The usage is only inferable from the tool name and the word 'shipment'.
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.