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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "spicrawl_docs_search"
  }
}

Input Schema

Name	Required	Description	Default
`limit`	No	Maximum pages to return, 1-20. Default 8.
`query`	Yes	What to look for: a feature, parameter, error code or question, e.g. 'wait_for selector' or 'ERR::AUTH::INSUFFICIENT_SCOPE'.

Output Schema

Name	Required	Description
`hint`	No	What to try when there are no results.
`query`	Yes	The search text, as sent.
`results`	Yes	Matching pages, most relevant first. Empty when nothing matched.
`error_code`	No	Present when the query is an error code (ERR::AREA::NAME).

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 13, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": true,
+  "properties": {
+    "error_code": {
+      "additionalProperties": true,
+      "description": "Present when the query is an error code (ERR::AREA::NAME).",
+      "properties": {
+        "code": {
+          "type": "string"
+        },
+        "md_url": {
+          "description": "The errors page as Markdown; read it with spicrawl_docs_read.",
+          "type": "string"
+        },
+        "note": {
+          "type": "string"
+        },
+        "url": {
+          "description": "The code's entry on the errors page.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "code",
+        "url",
+        "md_url"
+      ],
+      "type": "object"
+    },
+    "hint": {
+      "description": "What to try when there are no results.",
+      "type": "string"
+    },
+    "query": {
+      "description": "The search text, as sent.",
+      "type": "string"
+    },
+    "results": {
+      "description": "Matching pages, most relevant first. Empty when nothing matched.",
+      "items": {
+        "additionalProperties": true,
+        "properties": {
+          "breadcrumbs": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "matches": {
+            "items": {
+              "additionalProperties": true,
+              "properties": {
+                "heading": {
+                  "description": "The section the match is in.",
+                  "type": "string"
+                },
+                "snippet": {
+                  "description": "A short plain-text excerpt around the match.",
+                  "type": "string"
+                },
+                "url": {
+                  "description": "Link to the section, with its #anchor.",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "url"
+              ],
+              "type": "object"
+            },
+            "type": "array"
+          },
+          "md_url": {
+            "description": "The page as Markdown; pass it to spicrawl_docs_read.",
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "url": {
+            "description": "The page on the docs site.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "title",
+          "url",
+          "md_url",
+          "matches"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "query",
+    "results"
+  ],
+  "type": "object"
+}

First observedOct 1, 2026

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 (readOnly, idempotent, openWorld, non-destructive). The description adds meaningful behavior: the result shape (best-matching pages with title, matching sections, snippets, url, md_url) and the fact that error-code searches carry a direct link to that code's entry. It doesn't mention rate limits or result ranking behavior, so not quite a 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?

Front-loaded with purpose and dense throughout, with no obvious filler. It is on the long side for what it covers, but each sentence carries distinct information (purpose, input guidance, return shape, next step).

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 output schema already exists, the description needn't explain return values yet chooses to summarize them, and it fully documents when to use the tool, how to phrase queries, and how to chain to spicrawl_docs_read. An agent has everything needed to invoke it 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. The description goes beyond the schema by clarifying what the query should contain (feature, parameter, error code or question) and by explaining the error-code lookup behavior with a concrete example, adding genuine semantic value.

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 (full-text search) and resource (Spicrawl documentation), and names the scope of the corpus (guides, API reference, errors, limits). An agent can distinguish it from sibling docs tools like spicrawl_docs_read and spicrawl_docs_index without opening any 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?

Explicitly says when to use it (look up a parameter/value for a spicrawl_* tool, or explain an error) and how to handle errors (search the error code itself). It also routes the agent to the correct follow-up, telling it to call spicrawl_docs_read with the returned md_url or url.

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

All Spicrawl tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?