Skip to main content
Glama

Analyse a building's roof

analyse_roof
Read-onlyIdempotent

Reads one building's roof from imagery, by the buildingId an earlier result gave, and returns it plane by plane (facing, pitch, area, sunshine, panels) with the panels it can carry, their capacity and yearly yield. Use for questions about one building's roof or the solar it can carry: "what is the roof like?", "how many panels fit?", "which way do the roof planes face?". It analyses one building per request; search results already carry stored solar figures. A roof already measured is returned from the record at no analysis cost; otherwise the request itself starts a new analysis. Cost: 1 credit when a new analysis measures the roof (an estimate-only result is free), plus 1 credit to open a building the workspace has not opened in the last year. status is on_record (returned from the record), analysed (a new analysis finished), running (still in progress, usually done within about 20 seconds; a repeat request for the same building joins the same run and is never charged twice) or not_analysed (nothing covers this roof yet). When the roof could not be measured, the figures are an estimate from its footprint, marked basis estimated and planesAreAssumed true. Where the roof measured took in the roofs attached to the building, it is cut to the building's outline and marked basis measured_cut_to_outline. Where an open survey measured the planes on the building, roofSurvey says how: lidar or image_matching.

Input Schema

NameRequiredDescriptionDefault
buildingIdYesThe baseray building id (`buildingId` in an earlier result).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / buildingId / description
      Previous value: -"The baseray building id returned by find_buildings or search_buildings."New value: +"The baseray building id (`buildingId` in an earlier result)."
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnlyHint, idempotentHint, openWorldHint), and the description adds substantial context the annotations cannot: the credit cost model (1 credit for a new analysis, free estimate-only, 1 credit to open a building not opened in a year), all four `status` semantics, the ~20s running duration with repeat-request deduplication, and the `basis`/`planesAreAssumed`/`roofSurvey` fallback semantics. This is exactly the extra behavioral detail an agent needs before invoking a metered tool.

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?

Information is front-loaded: purpose and return shape come first, then usage questions, then cost/status nuance. The status enumeration and basis clauses are long run-on sentences, but each clause carries real operational meaning, so the length is largely earned rather than padding.

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?

With no output schema and a single parameter, the description carries the full burden and meets it: it names the returned plane fields, the panel/capacity/yield figures, and the discriminator fields (`status`, `basis`, `planesAreAssumed`, `roofSurvey`). Nothing an agent needs to call this correctly or interpret the response is missing.

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% and there is only one parameter, so the baseline is 3. The description adds meaning beyond the schema by specifying where the value comes from ('by the buildingId an earlier result gave'), which helps an agent that has not retained the id know to pull it from a prior call.

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 ('reads one building's roof from imagery') and enumerates exactly what comes back (planes with facing, pitch, area, sunshine, panels; capacity and yield). It also distinguishes itself from siblings by noting that 'search results already carry stored solar figures', which tells the agent when the roof tool is the wrong one.

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 explicit when-to-use context with sample user questions ('what is the roof like?', 'how many panels fit?', 'which way do the roof planes face?') and the exclusion 'one building per request; search results already carry stored solar figures'. The condition selecting this tool over search/find siblings is unambiguous.

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