Skip to main content
Glama

crawl_site_markdown

Crawl a website from a single URL and convert each page into its own Markdown document for docs sites, blogs, or knowledge bases. Set maxPages to control cost.

Instructions

Crawl a website starting from one URL and return one Markdown document per page (docs sites, blogs, knowledge bases). Billed per page crawled, so keep maxPages as low as the task allows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe page to start crawling from, e.g. https://docs.apify.com/platform.
maxDepthNoHow many links deep to follow from the start URL.
maxPagesNoMaximum number of pages to crawl and convert. This is the billed unit — raise only as needed.
useSitemapNoAlso seed the crawl from the domain's sitemap.xml.
outputFormatNoContent format to return per page.markdown
sameDomainOnlyNoOnly follow links on the same domain as the start URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses that billing is per page and that output is one Markdown document per page, but it omits other relevant crawl behaviors such as rate limits, robots.txt handling, or error behavior.

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?

Two sentences, front-loaded with the core action and output, then immediately followed by the important billing constraint. Every sentence earns its place with no filler.

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

Completeness4/5

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

The tool has no output schema, and the description clearly explains the return unit (one Markdown document per page). With 100% schema coverage, parameter details are adequately handled elsewhere, though the absence of annotations means additional behavioral context could still improve completeness.

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%, so all six parameters are already documented in the input schema. The description only reinforces the billing meaning of maxPages, adding little parameter semantics beyond what the schema provides, which matches the baseline of 3.

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?

The description names a specific verb and resource: crawl a website from one URL and return one Markdown document per page. It gives useful examples (docs sites, blogs, knowledge bases) but does not explicitly differentiate from sibling tools such as read_url, which may still cause selection ambiguity.

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

Usage Guidelines3/5

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

It implies the tool is for multi-page documentation, blog, or knowledge-base crawling and warns that billing is per page. However, it does not state when to choose this over read_url or web_search, nor does it specify exclusions or prerequisites.

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