Skip to main content
Glama

Binyan.im · בניינים

Apartment ledger

get_apartment_ledger
Read-only

Chronological statement for one apartment with dues, manual charges, refunds, payments, offsets and manual credits plus a running balance. Residents can read their own apartment only.

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

Input Schema

NameRequiredDescriptionDefault
asOfDateNo
buildingIdYes
apartmentIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered; the description adds real value beyond that by disclosing chronological ordering, the presence of a running balance, and the per-resident access restriction. It does not mention result size, pagination, or whether asOfDate truncates the statement, which are the remaining behavioral gaps.

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?

Two sentences, no filler, with the substantive content description front-loaded before the access caveat. The dense enumeration is efficient, though the final sentence is terse enough to be slightly ambiguous about who the constraint binds.

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?

With no output schema, the description does the right thing by enumerating the returned line types and the running balance. However, for a read tool whose result could be large and whose asOfDate parameter is unexplained, an agent still lacks enough to call it confidently or predict output shape.

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

Parameters2/5

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

Schema description coverage is 0% and the description does not clarify any of the three parameters. 'One apartment' hints at apartmentId's role, but buildingId's purpose and especially the semantics of asOfDate (does it cut off the statement at that date, or filter entries?) are left entirely undefined.

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 names a specific resource (a single apartment's ledger) and enumerates exactly what the statement contains: dues, manual charges, refunds, payments, offsets, manual credits, plus a running balance. This distinguishes it in substance from siblings like get_fund_balance or get_cash_box, though it never names those alternatives 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?

The only guidance is a scope/authorization constraint: 'Residents can read their own apartment only.' There is no statement of when an agent should call this versus the payment/charge/offset listing tools or the financial report tool, so usage must be inferred from the content list.

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