Skip to main content
Glama
blackwaxxx

buildium-mcp

by blackwaxxx

Buildium List Units

buildium_list_units
Read-onlyIdempotent

Retrieve rental units from Buildium, optionally filtered by property, with options to count records or fetch totals across all pages.

Instructions

List rental units, optionally filtered to one property.

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.
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. Changed7 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 / 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.6/5.0
Behavior4/5

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

Annotations already provide readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is clear. The description adds behavioral context about pagination via all_pages and count_only, noting limits and that single pages are insufficient for totals. This is valuable but not exhaustive, as it doesn't mention response shape or error cases, but given annotations, a 4 is justified.

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?

The description is extremely concise, with two sentences: one states the core purpose, the other directs usage for counts and totals. The key usage guidance is front-loaded. Every word is functional, with no fluff.

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

Completeness4/5

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

Given the tool's moderate complexity (7 optional parameters), the description covers the main decision points (when to use count vs totals) and the schema covers parameters in detail. There is an output schema, so return values are not the description's job. The only minor gap is that it doesn't mention the `exclude_fixtures` parameter's role, but the schema and health tool reference cover it, so completeness is high.

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 100%, with detailed parameter descriptions, so baseline is 3. The description adds value by explaining the purpose of all_pages ('for totals') and count_only ('for how many questions'), and mentions the `fields` parameter in the schema to filter large records. This goes beyond schema basics, justifying a 4.

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 clearly states the tool lists rental units with optional filtering by property, using a specific verb ('List') and a resource ('rental units'). It distinguishes itself from siblings like buildium_list_rentals by focusing on units, and from count_only/all_pages modes.

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 explicitly specifies when to use count_only for counting and all_pages for totals, and warns against using single-page results for aggregates. This guides the agent on mode selection, though it doesn't explicitly mention alternatives for listing rentals, but the sibling context is implied.

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