gh_data_tree_set_batch

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

Annotations only declare readOnlyHint=false, so the description carries the burden of explaining side effects. It discloses that the GH document is paused during assignment and recomputed exactly once, which is genuinely useful behavioral context for a mutation tool. A small gap remains around mid-batch failure behavior, but the core side effect is well covered.

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?

Two sentences, front-loaded with the purpose statement, with no filler. The defer_solve explanation earns its place by pairing the mechanism with the motivating use case.

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?

For a complex nested-schema write tool, the description plus annotations and output schema cover the essential call requirements: what to write, the batching mechanism, and the read-only/write posture. It doesn't spell out that a GH document must exist or how component_id maps to an added component, but sibling tools (gh_add_component, gh_data_tree_get) establish that context.

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?

Top-level schema coverage is 0%, so the description must compensate; it thoroughly explains defer_solve's behavioral meaning and why its True default matters. The remaining parameters (assignments, component_id, branch path/value structures) are structurally clear and partially documented inside the nested schema defs, so the description doesn't need to re-explain them.

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 action ('Apply many DataTree assignments') on a concrete resource, and the 'many ... at once with a single GH solve' phrasing encodes the batch semantics that distinguish it from the single-assignment sibling gh_data_tree_set. The annotation title 'GH: Write DataTree (batch)' reinforces the write direction.

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 explicitly contrasts the tool with N independent 'set' calls and identifies the exact scenario (parameter sweeps) where batching is critical. It also explains the default defer_solve=True behavior as the mechanism that makes the batch path preferable, giving an agent a clear decision rule.

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