gh_data_tree_get_batch

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

Annotations already declare readOnlyHint=true, indicating a read operation. The description adds value by specifying 'multiple component outputs' and 'single bridge round-trip,' which implies efficiency and batching. This contextualizes the behavior beyond the annotation alone.

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 a single, concise sentence that immediately conveys the tool's purpose and key trait (batching). No wasted words; it is appropriately front-loaded.

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?

Given that an output schema exists (not shown), the description does not need to explain return values. It mentions batching and round-trip efficiency, which is sufficient context for a read tool. However, it could benefit from noting that the input is a batch of component output requests.

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%, meaning the schema itself provides no parameter descriptions. The description does not elaborate on the parameters (e.g., what 'queries' or 'component_id' mean), leaving the agent to rely solely on the schema structure. This is a significant gap.

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 clearly states 'Read multiple component outputs in a single bridge round-trip,' which specifies the verb (Read), resource (component outputs), and batching behavior. This distinguishes it from sibling tools like gh_data_tree_get (single read) and gh_data_tree_set (write).

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 usage for batch reading, but it does not explicitly state when to use this tool vs gh_data_tree_get (single read) or gh_data_tree_set (write). No alternatives or exclusions are mentioned, leaving the agent to infer context from the name and sibling list.

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