Create an offer document. Admins only.
yardstick_offers_library_documents_createCreate an offer document. Admins only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| name | Yes | ||
| request_id | No | ||
| idempotency_key | Yes |
yardstick_offers_library_documents_createCreate an offer document. Admins only.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| name | Yes | ||
| request_id | No | ||
| 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, destructiveHint=false, idempotentHint=true, and openWorldHint=false, so the safety and replay profile is covered. The description adds one real piece of behavioral context the annotations lack: the admin-only authorization requirement. It says nothing about what the created document state is or what happens on duplicate idempotency keys.
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 single sentence is front-loaded and free of padding, so there is no wasted wording. But it is under-specified rather than concise, and it merely echoes the title rather than conveying distinct information.
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 mutation tool with no output schema, 0% parameter coverage, and complex create semantics implied by idempotency_key/request_id, the description is far too thin. Only the admin restriction is conveyed; the create behavior, required fields meaning, and result are left entirely to the schema.
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 four parameters (idempotency_key, name, kind, request_id), so the description carries the burden of clarifying them and provides nothing. The enum on kind and the length constraints in the schema supply partial semantics on their own, but the description adds no meaning about idempotency or request_id.
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" signals a permission precondition, which is minor usage value. However there is no guidance on when to use this tool versus the many other create/add document tools, no prerequisites, and no statement of what an offer library document is relative to an offer-attached document.
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.