aiworkhub_runtime_coverage_preview

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

The readOnlyHint annotation already declares the safety profile, and the description mainly reinforces that with 'READ-ONLY'. It adds useful context that the artifact is repo-local coverage.py JSON, but does not describe validation, error behavior, or how parsing differs from importing.

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?

A single front-loaded sentence with no wasted words. The read-only constraint and core action are immediately clear.

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?

Output schema exists, so return shape need not be explained. However, for a preview tool with an undocumented path parameter and a related import sibling, the description leaves out enough operational context that an agent could still hesitate about correct invocation conditions.

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 0%, so the description must carry parameter meaning. It partially does by identifying artifact_path as a repo-local coverage.py JSON artifact, but it does not specify path format, relative vs absolute expectations, or failure conditions.

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?

States a specific verb/resource pair: parse a repo-local coverage.py JSON artifact. The read-only preview intent is clear, but the description does not explicitly contrast with the sibling aiworkhub_runtime_coverage_import.

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 does not say when to use this preview versus the import sibling or any other alternative. 'READ-ONLY' implies a non-mutating mode, but no explicit usage guidance or exclusions are provided.

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