Skip to main content
Glama

crawl_project

Crawl a project's internal pages using breadth-first link discovery, bounded by configurable page and depth limits. Returns discovered URLs and uncrawled page count, with optional meta data extraction and Markdown storage.

Instructions

Discover a project's pages by breadth-first crawling internal links from its base URL, bounded by max_pages/max_depth (overridable per call). Discovery is deterministic (links sorted before the cap) and sitemap-seeded when a sitemap.xml/robots.txt Sitemap is present, so the same site yields the same page subset every run. Returns the discovered URLs plus pages_not_crawled[] (≤100, else a count) so a hit cap is never silent. Runs in the project's authenticated context. Set meta=true to also get each page's title + meta description (captured during the crawl, so behind-login/JS pages work), and save_md=true to save every crawled page as readable Markdown to data/fetches// (returns pages[] with saved_path + saved_dir). Discovery (optionally + capture) — use test_project to crawl and run full audits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
metaNoAlso return each crawled page's title + meta description in pages[] (default: false).
projectYesProject name
save_mdNoSave each crawled page as readable Markdown to data/fetches/<project>/ (default: false). Returns saved_dir + per-page saved_path.
save_dirNoDirectory to save Markdown into (implies save_md=true). Defaults to data/fetches/<project>/.
max_depthNoOverride max depth for this crawl
max_pagesNoOverride max pages for this crawl. 0 = the WHOLE site (unbounded, stops at a safety ceiling of 2000 and flags ceiling_hit).
use_sitemapNoSeed discovery from sitemap.xml / robots.txt Sitemap: lines when present (default: true). Set false for pure link-crawl.
Behavior5/5

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

With no annotations, the description fully discloses behavior: BFS crawling, determinism, sitemap seeding, return format with pages_not_crawled, authenticated context, and parameter effects like max_pages=0 unbounded up to 2000. No contradictions.

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

Conciseness4/5

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

The description is dense but slightly long. It front-loads the core purpose. Could be slightly more concise, but every sentence adds value.

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

Completeness5/5

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

Given the complexity of 7 parameters and no output schema, the description explains return values, edge cases (max_pages=0, safety ceiling), behavior highlights, and provides sufficient context for effective use.

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 coverage is 100% with detailed descriptions for all 7 parameters. The description adds minimal new information about parameters beyond the schema, so baseline 3 is appropriate.

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

Purpose5/5

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

The description clearly states the tool discovers a project's pages via breadth-first crawling from its base URL, with bounds. It distinguishes from sibling tools like test_project by noting that test_project is for full audits.

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

Usage Guidelines4/5

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

The description explicitly advises using test_project for full audits, providing a clear alternative. It does not explicitly state when not to use this tool, but gives context for alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/segentic-lab/periscope-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server