Skip to main content
Glama

Read a Spicrawl docs page

spicrawl_docs_read
Read-onlyIdempotent

Fetches one Spicrawl documentation page as Markdown. path may be a page path (guides/anti-bot), a docs URL from spicrawl_docs_search (url or md_url), or either with a #anchor (the whole page is returned; the anchor names the section to look at). Only pages on the Spicrawl docs (https://docs.spicrawl.com/docs) can be read. Pages over 60000 characters are truncated, and the text says so. Don't know the path? Use spicrawl_docs_search, or spicrawl_docs_index (llms.txt) for the list of every page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPage path (`guides/anti-bot`, `errors#AUTH_INVALID_KEY`) or a full docs URL, as returned by spicrawl_docs_search.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesWhere the document lives on the docs site.
titleNoThe page's first heading, when it has one.
md_urlNoThe Markdown source it was read from.
contentYesThe document as Markdown.
sectionNoThe #anchor that was asked for, without the #. The whole page is returned.
truncatedYesTrue when the content was cut at the size cap; the content says so at its end.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "content": {
      +      "description": "The document as Markdown.",
      +      "type": "string"
      +    },
      +    "md_url": {
      +      "description": "The Markdown source it was read from.",
      +      "type": "string"
      +    },
      +    "section": {
      +      "description": "The #anchor that was asked for, without the #. The whole page is returned.",
      +      "type": "string"
      +    },
      +    "title": {
      +      "description": "The page's first heading, when it has one.",
      +      "type": "string"
      +    },
      +    "truncated": {
      +      "description": "True when the content was cut at the size cap; the content says so at its end.",
      +      "type": "boolean"
      +    },
      +    "url": {
      +      "description": "Where the document lives on the docs site.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "url",
      +    "truncated",
      +    "content"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds real behavioral context beyond that: pages over 60000 characters are truncated and the text says so, and only pages under https://docs.spicrawl.com/docs can be read.

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?

Four tight sentences, all front-loaded with the core action first, then accepted input forms, then the domain limit, then routing to alternatives. No filler.

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?

Output schema exists so return values need no explanation; what remains an agent needs (accepted path formats, anchor semantics, truncation behavior, domain restriction, fallback tools) is all present.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description genuinely enriches the single `path` parameter: it accepts a page path, a docs URL from search (url or md_url), or either with a `#anchor`, and clarifies the anchor only names the section to look at while the whole page is returned.

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?

States a specific verb and resource ('Fetches one Spicrawl documentation page as Markdown') and scopes it to a single page, which cleanly separates it from siblings like spicrawl_docs_search and spicrawl_docs_index.

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

Usage Guidelines5/5

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

Explicitly names the alternatives and the condition for using them: 'Don't know the path? Use spicrawl_docs_search, or spicrawl_docs_index (llms.txt) for the list of every page.' It also states the domain restriction on which pages can be read.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources