scan_filesystem

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

Annotations declare readOnlyHint=true, consistent with the scanning action. The description adds context about supported file formats and use of Trivy, which helps the agent understand scope. However, it does not disclose potential network access or database updates required by Trivy.

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 with no redundancy. First sentence provides verb, resource, and purpose. Second sentence lists supported formats. Information is front-loaded and efficient.

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?

The description covers purpose and supported formats well but lacks details about output structure (no output schema). Given 5 parameters and annotations, the description is adequate but could be improved by hinting at return value format.

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% for all 5 parameters. The description adds no additional meaning beyond schema definitions (e.g., defaults or behavior for path parameter). Baseline score 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?

Description clearly states the tool scans local directories or files for vulnerabilities, misconfigurations, and secrets using Trivy. It lists supported file types (Dockerfiles, Terraform, K8s, deps), distinguishing it from siblings like scan_image or scan_repository.

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?

Description implicitly indicates this is for local filesystem scanning, but does not explicitly state when to use this tool versus alternatives (e.g., scan_image for container images). No exclusion criteria or alternative tool names are mentioned.

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