batch_explain_entities

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

Annotations already provide readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds that it loads the search index once, which is behavioral context beyond annotations. No contradictions. The requirement of prior index_repository call is also disclosed.

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?

Three concise sentences, front-loaded with the primary action, then efficiency and prerequisite. No extraneous information.

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 description covers the main purpose, efficiency benefit, and a critical prerequisite. While it does not detail return value (no output schema), the tool name and context imply textual explanations. The depth parameter is documented in schema. Could mention that 'shallow' uses only the index, but schema covers it. Overall complete enough for a batch tool.

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 coverage is 100% with descriptions for all three parameters. The description mentions 'depth' is an enum but does not add new meaning beyond what the schema provides. Thus baseline 3 is appropriate.

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?

Clearly states it explains multiple code entities in one call, using the search index for efficiency. Distinguishes itself from the sibling 'explain_entity' by highlighting the batch nature and prerequisite.

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?

Explicitly states when to use: more efficient than calling 'explain_entity' repeatedly. Also specifies a clear prerequisite: 'index_repository must be called first.' No guidance on when not to use, but the efficiency claim implies it's for multiple entities.

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