Skip to main content
Glama
office-books-mcp

office-books-mcp

by mjmirza

Get payments

get_payments
Read-only

Retrieve payment status and payment items for a voucher or sales document by ID, so you can review how and when the document was paid.

Instructions

Read the payment status and payment items of a voucher or sales document.

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_payments"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesId of the voucher or sales document

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds a small amount beyond that by indicating what is returned (payment status and items), but with no output schema it says nothing about empty-payment cases, result shape, or behavior for documents with no payments recorded.

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 resource and scope appear immediately. It is efficient, though its brevity borders on under-specification rather than optimal conciseness.

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?

The tool is low-complexity (one required UUID, no nesting) and its annotations cover the read-only profile. However, with no output schema the description is the only place return details could live, and "payment status and payment items" is too thin to tell an agent what to expect from the response.

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 100% and the single parameter is documented as "Id of the voucher or sales document," which is essentially identical to the description's phrasing. The description therefore adds no meaning beyond the schema, so the baseline 3 applies.

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 uses a specific verb ("Read") and names the exact resources returned (payment status and payment items) plus the scope (a voucher or sales document). It is distinguishable from get_voucher and get_sales_document in that it targets the payment facet rather than the document itself, though it never states that relationship explicitly.

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?

Usage is only implied: an agent can infer it should call this when payment status or payment line items are needed for a document whose ID it already holds. There is no statement of when not to use it, no mention of whether get_voucher or get_sales_document already surface payment data, and no prerequisite or error guidance.

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