scan_repository

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

No annotations provided, so description carries full burden. It mentions safety features (path resolution via security/paths.ts, bounded by ResourceGovernor) and return type (typed findings). However, it does not disclose potential side effects, error behavior, or destructive nature beyond the safe-by-default claim.

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 concise (two sentences) and front-loaded with the core action. However, the lack of parameter details makes it feel incomplete, slightly reducing efficiency.

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 complexity (6 parameters, no output schema, no annotations), the description is insufficient. It covers purpose and safety but omits parameter semantics, return value structure, and usage guidelines, leaving the agent underinformed.

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 0%, so the description must compensate. Despite six parameters including 'repoRoot', 'includeHidden', 'maxFiles', etc., the description provides no explanation of their meaning, defaults, or valid values. This leaves the AI agent without the information needed to set parameters correctly.

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 action (walk, parse, return) and resource (repository root) and specifies three types of findings (vulnerabilities, secrets, malformed inputs). It distinguishes the tool from siblings like audit_dependencies and generate_sbom.

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 the tool is for general repository scanning but does not explicitly state when to use it vs alternatives or provide exclusion criteria. Lacks guidance on prerequisites or context-specific usage.

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