Skip to main content
Glama

get_sales_document_status

Read-onlyIdempotent

Read a quote or invoice status and current revision by ID. Invoice amounts are in minor units of the returned currency.

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>"
    },
    "name": "get_sales_document_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavioral detail beyond them: the response carries a status plus a 'current revision', and invoice amounts are expressed in minor units of the returned currency. The minor-units caveat is exactly the kind of formatting context an agent would otherwise get wrong.

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 sentences, zero filler. The primary action and scope come first, and the minor-units caveat follows as a compact operational note that earns 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?

There is no output schema, so the description carries the return-value burden and does so reasonably: status, current revision, and currency/amount convention. For a single-parameter read tool with full annotation coverage this is nearly sufficient, with only the ID provenance left unspecified.

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%, but there is only one parameter and the schema already constrains it tightly as a UUID with a full pattern. The description adds that the ID addresses either a quote or an invoice, implying a shared document ID space, but does not clarify whether the same ID resolves both types or how to obtain one.

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?

States a specific verb (Read) and resource (quote or invoice status and current revision) with the lookup key (by ID). An agent can tell this is a point-fetch for a single sales document rather than a listing like list_sales_documents. It stops short of naming which sibling to prefer when the document type or ID is unknown.

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 explicit when-to-use or when-not-to-use guidance and no named alternative for discovering an ID or listing documents. Only the phrase 'by ID' implicitly signals that an identifier must already be known, which is weak routing information.

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