bmc_read

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

With no annotations, description effectively conveys the operation: reading raw values since last reset, no side effects implied. Mentions prerequisite and return format, providing sufficient transparency.

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?

Concise with clear Args/Returns sections; every sentence adds value. No wasted words.

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?

Covers all needed aspects: purpose, prerequisite, parameter usage, and return values. Output schema exists so return explanation is adequate.

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?

Adds meaning beyond schema: explains parameter 'counters' as list of names, gives examples (M1CNT, M2CNT), and clarifies behavior when empty/None (reads all). Compensates for 0% schema coverage excellently.

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?

Description clearly states 'Read current BenchMark Counter values.' with specific verb and resource, and distinguishes from sibling BMC tools like bmc_configure or bmc_reset by focusing on reading values.

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?

States prerequisite 'Target must be halted' which helps ensure correct invocation. Does not explicitly contrast with sibling tools (e.g., when to use bmc_read vs bmc_cache_analysis), but usage context is clear for a read operation.

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