Skip to main content
Glama

buildertrend_read

Read the current Buildertrend page to capture its text and numbered buttons, links, and fields, optionally scoped to a specific element for targeted inspection.

Instructions

Read the current Buildertrend page: its text and numbered buttons, links and fields.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "buildertrend_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
elementNoRead only inside this element.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose the key behavioral trait: the page is rendered as text plus *numbered* elements, which explains why other tools act on indices. It does not state prerequisites (an open Buildertrend page), what happens on failure, or whether the read has side effects, so the disclosure is partial.

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?

A single sentence that front-loads the action and enumerates the return contents with no filler. Nothing is redundant or buried.

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?

For a no-parameter, read-only automation step with no output schema, naming the returned element categories covers most of what an agent needs before calling. Missing only the prerequisites and the numbering convention that links this tool's output to sibling tools' index arguments.

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?

The optional `element` parameter is fully documented in the schema at 100% coverage, so the baseline is 3. The description never mentions scoping the read to a numbered element, adding nothing beyond the schema.

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

Purpose4/5

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

The description gives a specific verb and resource ("read the current Buildertrend page") and enumerates what comes back (text, numbered buttons, links, fields). That is enough to separate it from siblings like buildertrend_click or buildertrend_type, though no sibling is named explicitly.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance, nor any pointer to alternatives such as buildertrend_status or buildertrend_guide. The only hint is the word "current," which implies a page must already be open, but this is left to inference.

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