get_vulnerability_report

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

With no annotations, the description bears the full behavioral burden. It usefully discloses that the report is offline and contains no actual CVE data, which is the key behavioral caveat, but it says nothing about whether the path must exist, how large projects are handled, or what the report structure looks like.

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 short sentences, zero filler: the purpose comes first and the critical limitation is appended as a clearly marked note. Nothing could be removed without losing information.

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?

For a simple two-parameter read tool with a fully documented schema and no output schema, the description covers what the tool does and its main caveat. Only minor operational details (path validation, report format) are absent, which is acceptable at this complexity.

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 description coverage is 100%, so both parameters (path, includeDev) are already fully documented in the schema, including the default for includeDev. The description adds no parameter-level meaning beyond that, so the baseline of 3 applies.

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 uses a specific verb ("Generate") with a concrete resource ("offline dependency report listing all project dependencies"), which is clear enough for an agent to understand the output. It does not explicitly differentiate itself from the sibling "check_dependencies", leaving some ambiguity about which to pick, but the offline/vulnerability-review framing is distinctive.

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?

Usage is implied by "for vulnerability review" and the offline qualifier, and the note that CVE lookups need Phase 2b online integration effectively says what this tool will not do. However, no alternative tool is named and no explicit when-to-use/when-not guidance is given, so the agent must infer routing.

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