gh_data_tree_get_batch

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

The readOnlyHint annotation already signals the safe read-only nature. The description adds meaningful behavioral context by explaining that multiple reads are batched into a single bridge round-trip, which is not evident from the schema or annotation alone. It does not contradict any annotations.

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 appropriately concise: one sentence, front-loaded with the action, and every word adds signal. It avoids restating the name or schema.

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 output schema and annotations cover return values and safety, and the description covers the batching behavior. However, the lack of parameter semantics and the absence of guidance on how to construct queries leaves meaningful gaps for an agent selecting and invoking this tool, especially given the nested schema.

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?

Schema description coverage is 0%, so the description needs to compensate for parameter meaning, but it does not explain what 'component_id' refers to, what 'output' selects, or how the 'queries' array maps to results. The schema provides structure but not semantic meaning.

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 states a specific verb ('Read'), a specific resource ('multiple component outputs'), and a distinguishing mechanism ('in a single bridge round-trip'). This clearly separates it from single-output reads like gh_data_tree_get and from write operations like gh_data_tree_set_batch.

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 implies when to use this tool: when multiple component outputs need to be read and batching into one round-trip is desired. However, it does not explicitly name alternatives or state when NOT to use it, such as recommending the single-read variant for one output.

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