Skip to main content
Glama

Yardstick ATS

Add a published offer document to a draft offer.

yardstick_offers_documents_add
Idempotent

Add a published offer document to a draft offer.

Input Schema

NameRequiredDescriptionDefault
offer_idYes
request_idNo
template_idYes
idempotency_keyYes
expected_draft_revisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

D1.9/5.0
Behavior2/5

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 structurally. The description adds nothing on top: it does not explain the idempotency contract, the optimistic-concurrency behavior implied by expected_draft_revision, or what happens to the draft revision on success.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with zero filler, which is structurally clean. But it duplicates the title exactly, so the sentence does not earn its place by adding any information an agent did not already have.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 5-parameter mutation tool with no output schema and 0% schema coverage, the description is completely inadequate. It omits the idempotency key contract and the expected_draft_revision concurrency guard, both of which are required for a correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 5 parameters, so the description carries the full burden of explaining offer_id, template_id, idempotency_key, request_id, and expected_draft_revision. It mentions none of them, leaving the agent with bare type/format hints and no semantic meaning for any argument.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

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.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no prerequisites, and no mention of alternatives. An agent cannot tell from the description when to add a document versus editing, reordering, or copying one from the library, nor what state the draft offer must be in.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.