cwe_top25

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

No annotations are provided, and the description does not disclose any behavioral traits such as data recency, rate limits, error handling for invalid years, or whether the result is cached. This leaves gaps for the AI agent.

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?

Two sentences that efficiently convey the core function and the optional year parameter. No wasted words, but could be slightly more structured with bullet points for clarity.

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 lack of output schema, the description does not explain the return format (e.g., list of CWE IDs, descriptions, scores). For a simple tool this may be acceptable, but it could be more comprehensive to aid the agent.

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 schema covers the one parameter (year) with 100% coverage, so baseline is 3. The description adds that it shows rankings by frequency and severity, which provides slight extra context beyond the schema's year description.

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 specifies the tool retrieves the MITRE CWE Top 25 for a given year, with a focus on ranking vulnerability classes by frequency and severity. It distinguishes from sibling tools like cwe_get or cwe_lookup, which provide individual CWE details or hierarchical relationships.

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 by saying 'for a given year' and provides default year guidance. However, it does not explicitly state when to use this tool versus alternatives, nor does it provide conditions where it should not be used.

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