Skip to main content
Glama
blackwaxxx

buildium-mcp

by blackwaxxx

Buildium List Leases

buildium_list_leases
Read-onlyIdempotent

List rental leases with rent amounts and lease dates. Filter by property or status, count records, or fetch all pages for totals.

Instructions

List leases.

Each row already carries the rent terms under AccountDetails (including AccountDetails.Rent, the recurring monthly amount) and the lease dates. You do NOT need to open the transaction ledger to read a lease's rent — buildium_list_lease_transactions is for actual posted charges and payments, which is a different question.

For who is on each lease, use buildium_lease_roster.

To count, use count_only; for totals, all_pages.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoRecords per page, 1-1000.
fieldsNoKeep only these top-level fields in each record, e.g. ["Id", "Name"]. Buildium records are large and carry tax IDs and addresses you may not need.
offsetNoHow many records to skip. Use next_offset from the previous page.
all_pagesNoFollow pagination and return the records, up to 1000. Use it for totals and other aggregates; a figure from one page is wrong whenever there is more than one page.
count_onlyNoFollow every page, up to 100,000 records, and return only how many there are. Use it for "how many" questions.
property_idNoOnly this rental property.
lease_statusNoActive, Future, Past or Expired.
exclude_fixturesNoLeave out test records, whose names start with the fixture prefix (see buildium_health). When any are present the response says so either way.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.2.1
    • addedInput schema / properties / all_pages / description
      Added value: +"Follow pagination and return the records, up to 1000. Use it for totals and other aggregates; a figure from one page is wrong whenever there is more than one page."
    • addedInput schema / properties / count_only / description
      Added value: +"Follow every page, up to 100,000 records, and return only how many there are. Use it for \"how many\" questions."
    • addedInput schema / properties / exclude_fixtures / description
      Added value: +"Leave out test records, whose names start with the fixture prefix (see buildium_health). When any are present the response says so either way."
    • addedInput schema / properties / fields / description
      Added value: +"Keep only these top-level fields in each record, e.g. [\"Id\", \"Name\"]. Buildium records are large and carry tax IDs and addresses you may not need."
    • addedInput schema / properties / lease_status / description
      Added value: +"Active, Future, Past or Expired."
    • addedInput schema / properties / limit / description
      Added value: +"Records per page, 1-1000."
    • addedInput schema / properties / offset / description
      Added value: +"How many records to skip. Use next_offset from the previous page."
    • addedInput schema / properties / property_id / description
      Added value: +"Only this rental property."
  2. Changed1 schema field changedv0.2.0
    • addedInput schema / properties / count_only
      Added value: +{
      +  "default": false,
      +  "type": "boolean"
      +}
  3. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Among the annotations (readOnlyHint, openWorldHint, idempotentHint, destructiveHint), the read-only safety profile is already disclosed. The description adds useful behavioral context beyond annotations: each row already includes rent under AccountDetails, so no need to open the transaction ledger. It also clarifies pagination behavior by directing to count_only and all_pages. This goes beyond the structured data.

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?

Four tightly written sentences with zero filler. The first sentence states the core action, the next delivers the most useful non-obvious fact (rent is already in AccountDetails), and the following sentences route to alternatives and usage flags. Every sentence earns its place.

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?

With an output schema present and 100% schema coverage, the description needn't explain return fields. It addresses the two most likely mistakes an agent could make (opening the wrong endpoint for rent/occupants, or computing aggregates from a single page) and handles them explicitly. For a list tool of this complexity, this is complete.

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 coverage is 100%, so all 8 parameters are already well documented. The description reinforces the purpose of count_only and all_pages but doesn't introduce new semantic meaning beyond what the schema already provides. It also doesn't mention fields, limit, or property_id, but those are self-explanatory from the schema.

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?

The description opens with 'List leases.' — a clear verb plus resource. It then distinguishes itself from siblings by stating that buildium_list_lease_transactions handles actual posted charges and that buildium_lease_roster handles occupants, so an agent can immediately tell this tool apart.

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?

The description gives explicit when-to-use guidance: use buildium_list_lease_transactions for transactions, buildium_lease_roster for who is on the lease, and count_only/all_pages for counts and totals. It also states when NOT to use this tool (for reading rent, you don't need the ledger). This is model guidance.

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