Read an offer document, its draft and its versions. Admins only.
yardstick_offers_library_documents_readRead an offer document, its draft and its versions. Admins only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | No | ||
| template_id | Yes |
yardstick_offers_library_documents_readRead an offer document, its draft and its versions. Admins only.
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | No | ||
| template_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, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered structurally. The description does add one genuinely useful behavioral fact beyond annotations: the operation requires admin privileges. It says nothing about what the returned document/draft/version set contains or their relationship.
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, no filler, with the operational scope stated before the permission caveat. It is well formed, though the terseness contributes to the documentation gaps scored elsewhere rather than being a structural flaw.
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 read with no output schema, the description need not describe return values, and annotations cover the safety profile. But with two undocumented parameters at 0% schema coverage and no sibling disambiguation, the definition leaves the agent guessing about the key input identifier.
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% across two parameters (a required uuid template_id and an optional request_id), and the description explains neither. An agent receives no help on what template_id identifies or whether request_id is an idempotency key.
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?
Tautological: description restates name/title.
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?
"Admins only" is a permission constraint, not usage guidance. There is no statement of when to call this versus reading the list, updating the draft, or publishing, so an agent has no routing signal beyond the name.
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.