grn_listList goods-receipt notes newest first, with optional purchase-order filtering, to review received, damaged, or short units.
List goods-receipt notes, newest first, optionally filtered to one purchase order.
| Name | Required | Description | Default |
|---|---|---|---|
| po | No | Only GRNs against this purchase order | |
| includeLines | No | Include line detail |
Changes observed during successful MCP inspections.
v0.22.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only, idempotent, and non-destructive behavior. The description adds useful behavioral context beyond annotations by specifying sort order ('newest first') and optional filtering, which are not derivable from the schema or annotations.
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?
The description is a single, front-loaded sentence with no wasted words. It conveys the core action, ordering, and optional filter in minimal space.
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 low-complexity read-only list tool with two optional parameters and complete schema description coverage, the description provides everything an agent needs to invoke it correctly. No output schema exists, but the list semantics are clear from the tool name and description.
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%, so parameters are fully documented in the input schema. The description restates the PO-filter concept but does not add new meaning beyond the schema, meeting the baseline for high schema coverage.
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 states a specific verb and resource—'List goods-receipt notes'—and adds a distinguishing ordering detail ('newest first') and an optional scope ('filtered to one purchase order'). This clearly separates it from siblings like grn_get or grn_status_report.
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 description makes the intended use clear: list GRNs, with optional filtering by one PO. It does not explicitly name alternatives or exclusions, but the straightforward list/read semantics combined with sibling names give sufficient context for an agent to choose it appropriately.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.