Skip to main content
Glama
CryptoCultCurt

Appfolio MCP Server

get_occupancy_summary_report

Generate an occupancy summary report with number of units, occupied units, and vacancy rates. Filter by properties, groups, portfolios, or owners.

Instructions

Generates a summary of property occupancy, including number of units, occupied units, and vacancy rates. IMPORTANT: All ID parameters must be numeric strings (e.g. '123'), NOT names. Use directory reports to lookup IDs by name if needed. Common columns: 'number_of_units', 'occupied', 'vacant_rented', 'vacant_unrented', 'percent_occupied'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
propertiesNoFilter results based on properties, groups, portfolios, or owners
unit_visibilityNoFilter units by status. Defaults to "active"active
as_of_dateYesThe "as of" date for the report (YYYY-MM-DD). Required.
columnsNoArray of specific columns to include in the report. Valid columns: unit_type, number_of_units, occupied, percent_occupied, average_square_feet, average_market_rent, vacant_rented, vacant_unrented, notice_rented, notice_unrented, average_rent, property, property_id. If not specified, all columns are returned. NOTE: Use 'occupied' for occupied units count, 'vacant_rented' and 'vacant_unrented' for vacancy details.
Behavior2/5

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

No behavioral traits disclosed beyond the basic summary generation. No annotations provided, so description should cover read-only nature or performance implications, but it does not. Only mentions ID format which is parameter semantics.

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?

Two sentences plus a column list. No redundancy, front-loaded with purpose and critical usage note. Every sentence earns its place.

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?

Covers main purpose and parameter constraints but omits explanation of output structure (e.g., grouped by property) and the role of the nested properties object. Lacks guidance on how the filters interact or what the required as_of_date implies.

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%, so baseline is 3. Description adds value by emphasizing numeric string requirement for IDs and listing common columns with clarifications (e.g., use 'occupied' for count). Adds meaning beyond 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?

Clearly states verb 'Generates a summary' and resource 'property occupancy' with specific metrics (units, occupied, vacancy rates). Distincts from sibling reports like get_leasing_summary_report or get_unit_vacancy_detail_report.

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

Usage Guidelines4/5

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

Provides explicit instruction that IDs must be numeric strings and directs users to directory reports for ID lookup. Lacks explicit when-not to use or comparison with siblings, but the important note is highly actionable.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CryptoCultCurt/appfolio-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server