dompruner_sitemap

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

With no annotations, the description carries the full burden of disclosing behavior. It explains automatic sitemap index handling, DOM-pruned Markdown output, and a stated 90%+ token reduction. It does not detail failure modes or side effects (e.g., network load), but for a read-only crawler, the provided transparency is reasonably good.

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 and well-structured: the first sentence states the core action, the second frames the ideal use case, and the third gives a parameter tip. No unnecessary words or repetition, making it appropriately sized and front-loaded.

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 gives a good overall picture of the tool's purpose, capabilities, and typical use case. It covers the return type ('DOM-pruned Markdown'), automatic handling of sitemap indexes, and a filtering example. Lacking an output schema, it does not detail the exact response structure, but for a six-parameter tool with no annotations, this is reasonably 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 already provides 100% coverage with descriptions for all six parameters, so the baseline is 3. The description adds value by giving a concrete example for filter_urls ('/docs/', '/tutorial/'), but this is more of a usage guideline than new semantic meaning. Overall, the description does not significantly enhance parameter understanding beyond the schema.

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 tool's core function: 'Fetches all pages listed in a sitemap.xml and returns DOM-pruned Markdown for each.' It also specifies the scope (entire documentation sites) and a unique capability ('Handles sitemap indexes automatically'), which distinguishes it from sibling tools like dompruner_fetch.

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 a clear use case: 'Ideal for ingesting entire documentation sites into an LLM context.' It also offers a practical tip: 'Use filter_urls to limit to a path prefix (e.g. /docs/, /tutorial/).' However, it does not explicitly mention when not to use this tool or name alternative sibling tools, so it falls slightly short of a 5.

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