Skip to main content
Glama

List Apartments

list_apartments
Read-onlyIdempotent

List the account's apartments and their ids. Call this before any tool that takes apartment_id — get_stats requires it, the rest treat it as an optional filter.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
help_urlNoHelp-center article with step-by-step instructions for this area. Show it to the user when they need to change something in the panel.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedOutput schema / properties / help_url
      Added value: +{
      +  "description": "Help-center article with step-by-step instructions for this area. Show it to the user when they need to change something in the panel.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely non-structured context — that this is a prerequisite lookup whose output feeds apartment_id parameters elsewhere — but says nothing about ordering or pagination of the result set.

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 short sentences, no filler, with the purpose front-loaded and the calling dependency immediately after. Every clause earns its place.

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?

An output schema exists, so return values need not be explained, and the description covers the key integration fact (it supplies apartment_id values). It stops just short of noting anything about result ordering or scale, which is a minor omission for a no-arg list tool.

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?

The tool takes zero parameters, so there is no parameter semantics to document; the schema is empty and complete for its purpose. The baseline of 4 applies, with no gap the description could have filled.

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 and resource (list the account's apartments) and explicitly names the payload of interest (their ids). This clearly separates it from siblings like list_blocks, list_reservations, and list_reviews, which list different resource types.

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 an explicit calling rule: 'Call this before any tool that takes apartment_id,' then differentiates the dependents — get_stats requires it, the rest treat it as an optional filter. That is exactly the when/when-not/alternative guidance an agent needs.

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