Skip to main content
Glama
OfficialSpicrawl

Spicrawl MCP Server

Read a Spicrawl docs page

spicrawl_docs_read
Read-onlyIdempotent

Fetches a Spicrawl documentation page as Markdown from a path or URL, including a specific section via anchor. Use to access detailed docs content from the Spicrawl documentation site.

Instructions

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) 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. First observedv0.1.8

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, non-destructive, open-world, so the safety profile is covered. The description still adds real operational detail beyond them: the 60,000-character truncation with an in-text notice, the domain restriction, and the anchor behavior (whole page returned, anchor merely names the section). It does not mention whether authentication is required, which is a minor remaining gap.

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?

Three tight sentences, front-loaded with the core action, then accepted path forms, then limits and fallbacks. No sentence is redundant with the title or schema.

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?

For a single-parameter read tool with an output schema, everything an agent needs is present: accepted input forms, domain restriction, truncation behavior, and escape hatches to sibling lookup tools. Return-value detail is correctly omitted since an output schema exists.

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; the description exceeds it by explaining that `path` accepts three distinct forms (a bare page path, a url/md_url returned by spicrawl_docs_search, or either with a `#anchor`) and by clarifying the anchor's semantics. That is meaningfully more than the schema's one-line description.

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?

"Fetches one Spicrawl documentation page as Markdown" gives a precise verb, resource, and output format. It is immediately distinguishable from spicrawl_docs_search (find pages) and spicrawl_docs_index (list all pages), so an agent can pick it without opening a schema.

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?

It explicitly routes the agent: "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 boundary condition "Only pages on the Spicrawl docs (https://docs.spicrawl.com) can be read," so both when-to-use and when-not-to-use are covered.

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