Skip to main content
Glama
zxcvbbq
by zxcvbbq

api_monitor_read_api_definition

Read a bounded Rohitab XML API definition file to retrieve API specifications for monitoring and analysis.

Instructions

Read a bounded Rohitab XML API definition returned by the API search tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
max_charsNo
install_rootNo
definition_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.26

TDQS

B3.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It adds useful context by flagging that output is bounded (implying truncation via max_chars), but omits file-access behavior, whether install_root is required for resolution, and any error/truncation semantics.

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?

A single front-loaded sentence with no filler, but it is arguably too terse for a tool whose three parameters are entirely undocumented, leaving room for a clause on parameter meaning.

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

Completeness2/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 described, but with no annotations, zero schema description coverage, and three unexplained parameters, the description does not supply enough to call the tool confidently alongside its many siblings.

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

Parameters2/5

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

Schema coverage is 0% and none of the three parameters (definition_path, max_chars, install_root) are explained in the description. The word 'bounded' loosely hints at max_chars but gives no default or truncation behavior, leaving install_root and the required definition_path format unaddressed.

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?

States a specific verb (Read) and resource (a bounded Rohitab XML API definition), and ties it to the API search tool that produces it. It is distinguishable from api_monitor_parse_api_definition by naming the raw-read/returned-by-search origin, though it does not explicitly contrast the two.

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

Usage Guidelines3/5

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

The phrase 'returned by the API search tool' implies the workflow context (search first, then read the definition_path), but there is no explicit when-to-use, when-not-to-use, or alternative routing versus parse_api_definition or the sibling capture_read_definition.

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