Skip to main content
Glama

docs_add_url

Add documentation from a URL by scraping a page, optionally crawling linked pages and rendering JavaScript-built sites, so content can be stored and searched locally.

Instructions

Add documentation from a URL. Features: recursive crawling (follows links), Playwright support for JS-rendered sites (React, Vue, etc.), smart content detection. Use recursive=true to crawl multiple pages.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe URL to scrape
nameNoOptional: display name for the source
maxDepthNoMaximum depth for recursive crawling (default: 2)
maxPagesNoMaximum pages to crawl when recursive is true (default: 20)
sourceIdNoOptional: custom source ID (auto-generated from URL if not provided)
recursiveNoRecursively crawl linked pages
urlPatternNoOptional: regex pattern to filter URLs during recursive crawl
descriptionNoOptional: description for the source
usePlaywrightNoUse Playwright for JS-rendered pages (slower but handles React/Vue/Angular sites)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.2/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 crawling behavior, Playwright/JS-rendering support, and content detection, but says nothing about whether docs are persisted as a source, auth requirements, rate limits, or failure behavior for an add/mutation operation.

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?

Compact and front-loaded: purpose first, then feature/parameter notes. Each sentence carries some weight, though the feature list is somewhat marketing-flavored and could be tightened.

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?

For a 9-parameter mutation tool with no annotations and no output schema, the description covers the headline behavior but omits persistence semantics, auth, and result shape. Adequate but incomplete for the tool's complexity.

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 the schema already documents all 9 parameters, and the baseline is 3. The description largely restates schema facts (recursive crawling, Playwright for JS-rendered sites) rather than adding new meaning beyond what the input schema provides.

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 states a specific verb and resource: 'Add documentation from a URL.' It is clear what the tool does, but it does not differentiate itself from siblings like docs_add_sitemap, docs_add_openapi, and docs_add_swagger, which all also ingest docs from a URL source. Clear but not sibling-aware.

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 only guidance is 'Use recursive=true to crawl multiple pages,' which is a parameter hint rather than when-to-use guidance. Nothing says when to pick this tool over docs_add_sitemap/docs_add_openapi, nor any prerequisites or exclusions.

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