Skip to main content
Glama
blackwaxxx

buildium-mcp

by blackwaxxx

Buildium Describe Endpoint

buildium_describe_endpoint
Read-onlyIdempotent

Inspect any Buildium API endpoint's full contract: resolved parameters, request body, and success response schemas. Use before making calls to ensure required fields are known.

Instructions

Show the full contract for one endpoint: parameters, request body schema, and success response schema, with $refs resolved.

Call this before buildium_call_endpoint on anything non-trivial — especially writes, where the body schema tells you which fields are required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesBuildium API path, e.g. "/v1/vendors" or "/v1/leases/12345".
methodYesHTTP method: GET, POST, PUT, PATCH or DELETE.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.1
    • addedInput schema / properties / method / description
      Added value: +"HTTP method: GET, POST, PUT, PATCH or DELETE."
    • addedInput schema / properties / path / description
      Added value: +"Buildium API path, e.g. \"/v1/vendors\" or \"/v1/leases/12345\"."
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered. The description adds the useful detail that $refs are resolved, but otherwise it mostly restates the tool's purpose rather than revealing additional behavioral traits such as auth needs, rate limits, or edge cases.

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, both purposefulcars. The core contract is front-loaded, and the usage guidance follows naturally. No filler or redundant restatement of the tool name exists.

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

Completeness5/5

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

For an introspection tool with only two fully documented parameters, a strong usage pointer, and an output schema present, the description covers everything needed. There is no missing context that would prevent an agent from invoking it correctly.

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

Parameters3/5

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

Schema description coverage is 100%, so the input schema already explains both parameters well: path includes an example and method lists allowed HTTP verbs. The description adds no additional parameter-level meaning beyond calling them 'parameters,' so the baseline 3 applies.

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 states a specific verb ('Show'), a clear resource ('the full contract for one endpoint'), and enumerates exactly what is included: parameters, request body schema, and success response schema with $refs resolved. It is clearly distinguishable from sibling tools like buildium_describe_schema by focusing on an endpoint's full contract.

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 second sentence provides explicit, actionable guidance: 'Call this before buildium_call_endpoint on anything non-trivial — especially writes.' It names the relevant sibling tool and gives a concrete condition for when this tool is the right choice, which is exactly what an agent needs.

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