Archive an offer document. Admins only.
yardstick_offers_library_documents_archiveArchive an offer document. Admins only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | No | ||
| template_id | Yes | ||
| idempotency_key | Yes |
yardstick_offers_library_documents_archiveArchive an offer document. Admins only.
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | No | ||
| template_id | Yes | ||
| idempotency_key | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description does add a real behavioral fact beyond them - the admin-only authorization requirement - but says nothing about reversibility or effects on already-published documents.
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 with zero filler and the action front-loaded, which is structurally sound. But the brevity is under-specification rather than disciplined concision, given how much an agent still needs to know.
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 mutating admin operation with no output schema and 0% parameter documentation, the description is too thin: it omits what archiving does to the document's state, whether it is reversible, and any detail on the required parameters.
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 three parameters, including the required template_id and idempotency_key. The description supplies no meaning for any of them - not what template_id identifies, nor that idempotency_key prevents duplicate archives - so it fails to compensate for the coverage gap.
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?
The only guidance is 'Admins only', which is a permission prerequisite rather than usage guidance. There is no statement of when to archive versus remove, update_draft, or packets_archive, and no conditions or exclusions 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.