Skip to main content
Glama

prepare_sales_document_review

Read-onlyIdempotent

Check the saved quote or invoice revision and return its Cockatoo review link for the owner to inspect before sending.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>",
      "revision": "<revision>"
    },
    "name": "prepare_sales_document_review"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
revisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already establish readOnly, idempotent, non-destructive and closed-world behavior, so the safety profile is covered structurally. The description adds the useful facts that the result is a review link intended for human inspection before sending, but it does not say whether the link is generated fresh, whether it expires, or what happens if the revision does not exist or has already been reviewed.

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

Conciseness4/5

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

A single front-loaded sentence with no filler; the action, the target, and the output all appear in order. Nothing is wasted, though one short clause on the return or preconditions would still have earned its place.

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

Completeness4/5

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

For a two-parameter read-only tool with no output schema, the description covers the essentials: what is checked, what is returned, and who consumes the result. It falls short only on ambiguity around the id's referent and the absence of any failure-mode context.

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

Parameters3/5

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

Schema description coverage is 0%, so both parameters (id as a UUID and revision as an integer) are undocumented in the schema. The description implicitly maps id to the quote/invoice and revision to a revision number, which is helpful, but it does not clarify whether id is a quote id, invoice id, or shared document id, nor how revision numbers are assigned.

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

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description pairs a specific verb ('Check') with a specific resource ('the saved quote or invoice revision') and names the concrete output ('its Cockatoo review link'). That is enough to separate it from siblings like prepare_contract_review or get_sales_document_status, though it never explicitly contrasts itself with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

The phrase 'for the owner to inspect before sending' gives a clear situational context for calling the tool. However, there is no when-not guidance and no pointer to alternatives such as get_sales_document_status or list_sales_documents for other stages of the workflow, so the agent must infer the place in the sequence.

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.

Resources