Get document review
safefood360_get_document_reviewOne document review by its review number. GET /documents/sites/{siteId}/v1/documentreviews/{no}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| review_no | Yes | Document review number. |
safefood360_get_document_reviewOne document review by its review number. GET /documents/sites/{siteId}/v1/documentreviews/{no}.
| Name | Required | Description | Default |
|---|---|---|---|
| review_no | Yes | Document review number. |
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. The description adds the underlying endpoint path, which hints at site scoping, but says nothing about what is returned, error behavior, or pagination. Notably the path includes {siteId} while the schema exposes only review_no, an implicit-context detail left unexplained.
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, front-loaded with the purpose and followed by the endpoint reference. No filler or redundancy.
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?
This is a simple single-record read with full schema coverage and safety annotations, so little is required. Still, the description is essentially a restatement plus a URL, and gives no sense of the returned review object or what to do if the number is invalid.
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 100% and the single parameter is fully documented as 'Document review number.' The description's 'by its review number' restates the same meaning without adding format, source, or lookup guidance, so baseline 3 applies.
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 (one document review) plus the lookup key (review number), which distinguishes it from the sibling list_document_reviews by plurality. It does not name the sibling explicitly, but the singular framing is clear.
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?
'One document review by its review number' implies the usage: fetch a single review when you already have its number, as opposed to listing. However, no alternative is named and no prerequisites or failure conditions (unknown number) are given.
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.