docs_extract_code_snippets

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

No annotations are provided, so the description carries the full burden. It states the extraction action but does not disclose whether files are modified, the output structure, or any side effects. The phrase 'for quick inspection and review' hints at a read-only purpose, but does not explicitly state safety or behavioral traits. This is a notable gap for an operation that could potentially affect the environment.

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 a single concise sentence that front-loads the core action ('Extracts all fenced code blocks from markdown documentation') and adds a brief purpose without redundancy. Every word earns its place.

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 tool with one simple parameter and no output schema, the description covers the essential action. However, it lacks usage context (when to choose this over siblings), and does not mention details like recursion depth or handling of non-markdown files. Given the simplicity, it is adequate but not fully complete.

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 input schema has a single parameter, targetDir, with a description ('Directory to scan (defaults to cwd)') that provides full coverage. The tool description does not add additional parameter semantics, but since schema coverage is 100%, the baseline of 3 is appropriate.

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 states a clear verb and resource: 'Extracts all fenced code blocks from markdown documentation'. The added purpose 'for quick inspection and review' gives context. While it doesn't explicitly differentiate from siblings like docs_check_broken_links, the action is distinct enough that an agent can infer its main function.

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, typical scenarios, or when another tool would be more appropriate. For a documentation-related tool among siblings like docs_auto_fix_links, some routing information would be expected.

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