Skip to main content
Glama

Spicrawl

Search the Spicrawl docs

spicrawl_docs_search
Read-onlyIdempotent

Full-text search over the Spicrawl documentation (guides, API reference, errors, limits). Use it to look up a parameter name, value or combination for a spicrawl_* tool, or to explain an error a spicrawl_* tool returned: search the error code itself (e.g. ERR::UPSTREAM::CHALLENGE) and the result also carries a direct link to that code's entry on the errors page. Returns the best-matching pages, each with its title, the matching sections (heading, a short snippet, URL) and md_url; then call spicrawl_docs_read with a page's md_url or url to read it in full.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum pages to return, 1-20. Default 8.
queryYesWhat to look for: a feature, parameter, error code or question, e.g. 'wait_for selector' or 'ERR::AUTH::INSUFFICIENT_SCOPE'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, idempotentHint, openWorldHint, destructiveHint=false), so the description's added value is in return behavior: best-matching pages with title, matching sections (heading, snippet, URL) and md_url, plus a direct link to error-code entries. It stops short of describing ranking or pagination behavior, so not a full 5.

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?

A single dense paragraph that is front-loaded with the purpose, then usage, then return shape and next step. Every sentence carries information, though the length is near the upper bound of what is comfortable to parse at a glance.

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?

There is no output schema, so the description carries the return-value burden itself and does so fully: it describes page structure, section fields, md_url, and the error-code link. Combined with the routing to spicrawl_docs_read, an agent has everything needed to call and follow up correctly.

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 goes beyond the schema by giving concrete query examples ('wait_for selector', 'ERR::AUTH::INSUFFICIENT_SCOPE') and explaining that the limit governs returned pages. It adds real meaning to how the query should be formed.

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 ('Full-text search over the Spicrawl documentation') and scopes it to guides, API reference, errors and limits. It is cleanly distinguished from sibling docs tools spicrawl_docs_read and spicrawl_docs_index, which are named separately.

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?

Explicit when-to-use: look up a parameter name/value for a spicrawl_* tool, or explain a returned error by searching the error code itself. It also names the follow-up alternative (spicrawl_docs_read with md_url or url), so the agent knows the next step in the workflow.

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