scan_lockfile

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

Describes the scanning process: reads lockfile, queries NVD and GitHub Advisories, enriches with EPSS, returns prioritized report. Mentions default suppression of low-priority CVEs. No contradictions with annotations (none provided).

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, well-structured description with a summary paragraph followed by argument details. No unnecessary 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?

Comprehensive for a scanning tool: covers input, process, default behavior, and output (report). Output schema exists, so return values are documented elsewhere.

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?

Explains both parameters: lockfile_path requires an absolute path, show_all controls visibility of low-priority vulnerabilities. Adds meaning beyond schema (0% coverage in schema descriptions).

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?

Clearly states 'Scan a lockfile for known vulnerabilities' and specifies supported lockfile types. Differentiates from sibling tools like scan_project and lookup_cve.

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?

Provides context on default filtering behavior and how to override (show_all). Lacks explicit comparison to alternatives but is still clear.

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