Skip to main content
Glama

crawl_docs

Crawl a documentation site and save every page as Markdown with an index.md for offline or project-based reference.

Instructions

Crawl a documentation site and save every page as Markdown, plus an index.md.

Input Schema

NameRequiredDescriptionDefault
urlYesWhere to start, usually the docs home page.
directoryNoAbsolute folder to save into. Use a folder inside the user's project for project reference docs. Leave empty to use the global library.
max_pagesNoStop after this many pages.
path_prefixNoOnly crawl URLs whose path starts with this, like /docs/. Defaults to the start URL's path, so pass a broader prefix when starting from a page deep inside the docs.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses the output artifact (Markdown files plus index.md) but says nothing about rate limiting/politeness, robots handling, overwrite or failure behavior, or what happens on partial crawls — significant gaps for a tool that writes many files to disk.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence stating action and output with zero filler. Every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return-value explanation is correctly omitted, and the schema fully documents inputs. However, in a five-sibling docs/fetch/save library, the description omits the routing information (crawl-site vs fetch-single-page) and crawl-scope behavior that an agent needs to pick this tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and every parameter (url, directory, max_pages, path_prefix) is well documented with defaults and rationale in the schema itself. The description adds nothing about parameters, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (crawl), a specific resource (a documentation site) and the concrete outcome (every page saved as Markdown plus index.md). It clearly distinguishes the action from the sibling names fetch_markdown/save_markdown/list_library, though it never explicitly contrasts itself with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no when-to-use guidance, no alternatives, and no exclusions. It never tells the agent to prefer this over fetch_markdown for a single page, or when a crawl is inappropriate (e.g., huge sites, auth-protected docs). Usage is only loosely implied by the word 'crawl'.

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