Buildium Describe Endpoint

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

Annotations already cover readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is clear. The description adds that $refs are resolved, which is a behavioral detail beyond the schema. It also implies the tool does not execute the endpoint, but this is not explicitly stated, leaving a minor gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences. The first front-loads the core purpose, and the second provides targeted usage guidance. No filler or redundant information.

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

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

The tool has an output schema, so the description need not explain return values. It covers the essential information an agent needs: what the tool does, when to use it, and the fact that it resolves $refs. Given the annotations and schema, the description is complete for an agent to decide and invoke correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has no descriptions for 'method' and 'path' (0% coverage), so the description should compensate. It implies these identify the endpoint via 'one endpoint', but does not explicitly explain that 'method' is an HTTP verb (e.g., GET, POST) or that 'path' is the URL path. The names are self-explanatory, but the description does not fully clarify expected formats or constraints.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the tool shows the full contract for one endpoint (parameters, request body schema, success response schema, with $refs resolved). This clearly identifies the verb and resource, and differentiates it from siblings like buildium_call_endpoint (which executes) and buildium_search_endpoints (which searches).

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

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

The description gives direct guidance: 'Call this before buildium_call_endpoint on anything non-trivial — especially writes...' It names the specific sibling and the conditions for use, leaving no ambiguity about when to invoke this tool.

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