Skip to main content
Glama

Get Tenant Ledger

get_tenant_ledger
Read-onlyIdempotent

A resident's charge / payment / credit history with their current balance.

Use for "show this resident's payment history", "what has this tenant been charged", "what does tenant X currently owe", "ledger for tenant X". Pulls the tenant's transaction ledger and renders it newest-first with per-period subtotals (charged / paid / credits), plus Rent Manager's authoritative current balance. Find the TenantID with list_tenants. Optional start_date / end_date (MM/DD/YYYY) window the history; limit caps the lines shown (default 40, max 200).

``location`` (optional): a Rent Manager Location ID, a comma-separated
list, or ``"all"`` to run across every Location on this connection (see
``list_locations``). Blank = all Locations if the connection has several,
else its only Location. Output is labelled per Location; a Location that
can't be reached is listed as skipped. IDs (property, tenant, ...) belong
to one Location, so pass that Location when you filter by one.

Input Schema

NameRequiredDescriptionDefault
limitNo
end_dateNo
locationNo
tenant_idYes
start_dateNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / location
      Added value: +{
      +  "default": "",
      +  "title": "Location",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds substantial context beyond that: newest-first ordering, per-period charged/paid/credit subtotals, Rent Manager's authoritative balance, the 40/200 limit bounds, and that unreachable Locations are reported as skipped rather than silently dropped. That skipped-location disclosure is exactly the kind of partial-failure behavior an agent needs.

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?

Front-loaded with the one-line purpose followed by example queries, then parameter notes — good structure. It is slightly padded in places ("Pulls the tenant's transaction ledger" largely restates the opening sentence, and the location paragraph is dense), but nothing is irrelevant.

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

Completeness5/5

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

For a 5-parameter read tool with an output schema and read-only annotations, the description covers purpose, argument sourcing, formats, defaults, ordering, aggregation, and multi-Location edge cases. Nothing needed to invoke it correctly is missing, and it correctly does not over-explain return structure since an output schema exists.

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

Parameters5/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 full burden and does: MM/DD/YYYY format for start_date/end_date, default 40 with max 200 for limit, and detailed location semantics (single ID, comma list, "all", blank behavior, per-Location labeling). It also tells the agent where to source tenant_id, including the warning to pass a Location when filtering by Location-scoped IDs.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource (pulls a resident's charge/payment/credit history plus current balance) and distinguishes it from the portfolio-level analyze_* siblings and from get_tenant. An agent can tell immediately this is a per-tenant transaction listing, not an aggregate report.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives four concrete example phrasings that map to the tool, plus explicit prerequisite routing: find the TenantID via list_tenants, and see list_locations for Location IDs. It also states the blank-location default behavior, which removes the main ambiguity in choosing arguments.

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