oncofiles

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions scanning logs and returning findings, but doesn't specify whether this is a read-only operation, its performance impact, rate limits, or authentication requirements. For a tool that analyzes logs (potentially large datasets), this lack of detail is a significant gap.

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?

The description is well-structured and front-loaded with the core purpose, followed by details on scanning patterns and return value. It uses two concise paragraphs and a clear 'Args' section, with no wasted sentences. Minor improvement could be integrating the parameter info more seamlessly.

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?

Given the tool's complexity (analyzing logs for patterns), the description covers purpose, parameter semantics, and output intent (actionable findings for GitHub issues). With an output schema present, it doesn't need to detail return values. However, without annotations, it could better address behavioral aspects like data access scope or performance.

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?

The description adds meaningful context for the single parameter 'days' by explaining it as 'Number of days to analyze (default 7),' which clarifies its purpose beyond the schema's basic type and default. With 0% schema description coverage, this compensates well, though it could note constraints like minimum/maximum values.

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 tool's purpose: analyzing activity logs for errors, slow tools, and improvement opportunities. It specifies the resource (activity logs) and the analysis scope (patterns like recurring errors, slow operations, etc.). However, it doesn't explicitly differentiate from sibling tools like 'search_activity_log' or 'get_activity_stats', which might have overlapping functionality.

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 implies usage context by mentioning it 'scans the audit trail for patterns' and returns 'actionable findings for GitHub improvement issues,' suggesting it's for diagnostic or optimization purposes. However, it doesn't explicitly state when to use this tool versus alternatives like 'search_activity_log' or provide any exclusions or prerequisites.

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