pyocd_elf_info

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

No annotations provided, so description bears full burden. It explicitly states it 'gets information' (read-only) and lists what info is returned. It does not disclose preconditions, but the tool name and context imply an ELF is already attached, which is reasonable for a simple info retrieval.

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?

Single sentence, succinct, front-loaded with the verb. No extraneous words; every part adds value.

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?

With zero parameters and an output schema, the description fully conveys the tool's purpose. It explains what information is retrieved (arch, entry point, sections), which is sufficient for an agent to decide if this tool meets its need.

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?

No parameters, so baseline is 4. Description adds no parameter info, but none is needed. Schema coverage is 100% (no params).

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 the verb 'Get information' and resource 'attached ELF file', with specific examples (arch, entry point, sections). It distinguishes from siblings like pyocd_elf_lookup or pyocd_elf_symbols by being a general info tool, not a lookup or listing tool.

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?

No guidance on when to use vs alternatives. The description does not mention prerequisites (e.g., must have an attached ELF via pyocd_elf_attach) or exclude cases like when you need symbol lookup instead.

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