docs_preview

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

No annotations are provided, so the description must carry the full burden. It discloses the key behavioral trait ('without saving') and what is shown ('extracted content, metadata, and discovered links'), but does not mention potential side effects (e.g., network requests, rate limits) or authentication requirements. It covers the core non-destructive nature but lacks other operational details.

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, front-loaded with the core purpose and usage guidance. No unnecessary words; every sentence 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?

Given no annotations, no output schema, and a simple 4-parameter tool, the description covers purpose, usage, and basic output (content, metadata, links). It could be more complete by noting any limitations (e.g., does not follow redirects, may require auth), but it is sufficient for an agent to call the tool correctly.

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 the schema already documents all parameters. The description adds minimal parameter-specific meaning beyond the schema, but the tool's purpose implies the parameters are used for preview configuration. Baseline 3, but the 'without saving' context slightly clarifies that parameters like 'usePlaywright' affect the preview only, not stored docs.

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 a specific verb ('Preview') and resource ('scraped content'), and distinguishes it from the sibling 'docs_add_url' by emphasizing 'without saving' and 'test scraping before adding docs'.

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?

It gives explicit when-to-use guidance: 'Use this to test scraping before adding docs.' This directly names the alternative action (adding docs) and the condition (testing).

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