Skip to main content
Glama

Binyan.im · בניינים

Record payment

record_payment

Record a payment for an apartment. Defaults to status COMPLETED paid today. For prepayment of several months pass startDate and endDate (YYYY-MM); the debt calculation covers every month in that range. Pass cashBox true when the money went into the building cash box (CASH payments only; it defaults to true for CASH).

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": {
      "buildingId": "<buildingId>",
      "apartmentId": "<apartmentId>",
      "amount": "<amount>",
      "dueDate": "<dueDate>",
      "type": "<type>"
    },
    "name": "record_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeYes
amountYes
statusNoPayment status. The tool applies COMPLETED when this field is omitted.
cashBoxNoTrue when the money went into the building cash box. Only meaningful for CASH payments; other methods ignore it. Defaults to true for CASH and false otherwise.
dueDateYes
endDateNoWhole-month coverage end. For a 5-month prepayment use startDate '2026-09' and endDate '2027-01'. Any supplied day is normalized to the last day of its month.
paidDateNoDate the payment was paid. Defaults to today in the building time zone when status is COMPLETED.
startDateNoWhole-month coverage start. For a 5-month prepayment use startDate '2026-09' and endDate '2027-01'. Any supplied day is normalized to the first day of its month.
buildingIdYes
apartmentIdYes
descriptionNo
paymentMethodNoPayment method used when marking the payment COMPLETED. Defaults to BANK_TRANSFER.
referenceNumberNoOptional bank, cheque, card, or other transaction reference.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / cashBox
      Added value: +{
      +  "description": "True when the money went into the building cash box. Only meaningful for CASH payments; other methods ignore it. Defaults to true for CASH and false otherwise.",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly=false, destructive=false, idempotent=false, so safety is covered. Beyond that the description discloses the applied defaults (status COMPLETED, paid today, BANK_TRANSFER) and the debt-calculation side effect spanning every month in the range, which is genuinely useful non-obvious behavior. It does not warn about duplicate payments or what a record looks like afterward.

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?

Sentences are front-loaded: core behavior and defaults first, then prepayment, then cashBox. Dense but each sentence carries information; wording like 'the debt calculation covers every month in that range' is doing real work.

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 13-parameter mutation tool with no output schema, the description covers the tricky optional parameters well but leaves the required 'type' field, amount/dueDate intent, and any post-call result or failure behavior undocumented. Adequate, but an agent could still mis-populate required fields.

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

Parameters4/5

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

Schema coverage is 54%, so the description must carry weight, and it does: it explains the YYYY-MM format and whole-month debt coverage for startDate/endDate, and the CASH-only, defaults-true semantics of cashBox. Several params (amount, dueDate, description, referenceNumber) get no help, and the required 'type' field with no enum and no description is entirely unexplained, which is a notable hole.

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?

Opens with a specific verb and resource ('Record a payment for an apartment'), which is unambiguous about the write action. It does not distinguish itself from close siblings such as record_refund, record_offset, or update_payment, which is the only thing keeping it from 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?

Gives situational guidance inside the tool (use startDate/endDate for multi-month prepayment, use cashBox for money going into the building cash box), which tells the agent how to configure the call. It never states when to choose this tool over record_refund, record_offset, or update_payment, so sibling routing is left to inference.

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