Skip to main content
Glama

list_sales_documents

Read-onlyIdempotent

List quote and invoice references, statuses, revisions and recurring billing cadence. Set draftsOnly to list editable drafts or recurringOnly to list recurring invoices.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_sales_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNo
offsetNo
draftsOnlyNo
recurringOnlyNo

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?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds useful content context (it returns statuses, revisions and billing cadence) but says nothing about pagination behavior, result caps, or ordering, even though an offset parameter exists.

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

Conciseness5/5

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

Two tight sentences with zero filler, and the core purpose is front-loaded before the filter guidance. Every clause adds information an agent would otherwise have to guess.

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

Completeness3/5

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

For a four-parameter read-only list tool with no output schema, the description adequately conveys what fields are returned and how the two filter flags work. The notable omission is pagination: offset exists in the schema but the description never explains paging, ordering, or result limits, which matters for a list operation.

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 the description carries the burden of explaining four parameters. It clarifies draftsOnly and recurringOnly and implicitly covers kind by naming quotes and invoices, but offset is never mentioned, and there is no note on defaults or how the two boolean filters interact.

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 opens with a specific verb and resource: 'List quote and invoice references, statuses, revisions and recurring billing cadence.' That tells an agent exactly what comes back, which is more than a tautology. It does not explicitly contrast itself with nearby tools such as list_sales_document_deliveries or get_sales_draft, so it falls short of a 5.

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 second sentence gives operational guidance for two flags ('Set draftsOnly to list editable drafts or recurringOnly to list recurring invoices'), which implies when to use each mode. There is no explicit when-not guidance, no statement about combining the flags, and no pointer to alternative sibling tools for related lookups.

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