Skip to main content
Glama

Get Property Home Inventory

get_property_home_inventory
Read-onlyIdempotent

Build a one-row-per-unit home-inventory table across all home UDFs.

``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
fieldsNo
locationNo
shortnameNo
property_idNo
only_with_dataNo

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

B3.3/5.0
Behavior4/5

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

Annotations already declare it read-only, idempotent, non-destructive and open-world, and the description adds useful traits beyond that: output is labelled per Location, unreachable Locations are reported as skipped, and IDs are scoped to a single Location. It does not cover pagination, volume, or sorting of the result, so not a 5.

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?

The core purpose is front-loaded in the first line, and the location paragraph is dense but relevant. It is efficiently sized, with the only minor cost being the fragmented formatting of the ID-scoping remark.

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

Completeness2/5

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

An output schema exists, so return values need not be explained, but the description leaves four of five input parameters undocumented for a five-parameter tool with zero schema coverage. An agent cannot tell what fields or property_id/shortname do, nor what only_with_data=true excludes, so the definition is not complete enough to invoke it confidently.

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 only explains one of five parameters (location). fields, shortname, property_id and only_with_data are left entirely undefined, including the consequential only_with_data default of true, which changes what rows appear.

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?

States a concrete verb and resource: it builds a one-row-per-unit home-inventory table across all home UDFs. That is specific enough to place it apart from the analysis siblings, though it never explicitly distinguishes itself from the nearby get_property_udfs / get_unit_udfs, which an agent could easily confuse it with.

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?

Offers real guidance for the location argument (single ID, comma list, 'all', blank behavior) and points to list_locations, plus the rule to pass the owning Location when filtering by an ID. However, it gives no guidance on when to choose this tool over get_property_udfs or get_unit_udfs, so tool selection is still inferred.

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