doc-scraper

Overview Schema Source Related Servers Discussions Admin

search_docs

Read-onlyIdempotent

Instructions

Full-text search across all crawled documentation, ranked by relevance (BM25 with stemming), with zero network access. Results carry the page URL, its section heading path, and a snippet with match terms marked [like this]; follow up with read_page for the full page. Supports FTS5 syntax: quoted phrases, OR, and trailing * for prefix matching. Searches the stored index only; run crawl_site first for uncrawled sites.

Input Schema

Name	Required	Description
`limit`	No	Maximum results to return (default: 10, max: 50; larger values are capped, 0 or less means the default)
`query`	Yes	Search terms. Plain words are ANDed; when too few results contain every word, the rest are filled with partial matches (match: partial) that contain only some words or built-in synonyms of them. "quoted phrases", OR, and prefix* work too and are never relaxed.
`site_key`	No	Limit results to one site (use list_sites to discover keys). Omit to search all sites.

Output Schema

Name	Required	Description
`count`	Yes
`limit`	Yes
`query`	Yes
`results`	Yes
`site_key`	No	Present when the search was limited to one site
`next_actions`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedv2.21.0Oct 21, 2026

changedInput schema / properties / limit / description

Previous value: -"Maximum results to return (default: 10, max: 50)"New value: +"Maximum results to return (default: 10, max: 50; larger values are capped, 0 or less means the default)"

changedInput schema / properties / limit / type

Previous value: -"number"New value: +"integer"

addedOutput schema / properties / limit
```
Added value: +{
+  "type": "integer"
+}
```

changedOutput schema / required

Previous value: -[
-  "query",
-  "count",
-  "results",
-  "next_actions"
-]New value: +[
+  "query",
+  "count",
+  "limit",
+  "results",
+  "next_actions"
+]

Changed2 schema fields changedv2.15.0Oct 17, 2026

changedInput schema / properties / query / description

Previous value: -"Search terms. Plain words are ANDed; \"quoted phrases\", OR, and prefix* work too."New value: +"Search terms. Plain words are ANDed; when too few results contain every word, the rest are filled with partial matches (match: partial) that contain only some words or built-in synonyms of them. \"quoted phrases\", OR, and prefix* work too and are never relaxed."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "count": {
+      "type": "integer"
+    },
+    "next_actions": {
+      "type": "string"
+    },
+    "query": {
+      "type": "string"
+    },
+    "results": {
+      "items": {
+        "properties": {
+          "anchor": {
+            "type": "string"
+          },
+          "heading_path": {
+            "type": "string"
+          },
+          "match": {
+            "type": "string"
+          },
+          "rank": {
+            "type": "number"
+          },
+          "site_key": {
+            "type": "string"
+          },
+          "snippet": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "url": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "site_key",
+          "url",
+          "title",
+          "snippet",
+          "rank",
+          "match"
+        ],
+        "type": "object"
+      },
+      "type": [
+        "null",
+        "array"
+      ]
+    },
+    "site_key": {
+      "description": "Present when the search was limited to one site",
+      "type": "string"
+    }
+  },
+  "required": [
+    "query",
+    "count",
+    "results",
+    "next_actions"
+  ],
+  "type": "object"
+}

First observedSep 6, 2026

TDQS

A4.4/5.0

Behavior4/5

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

Adds context beyond annotations: BM25/stemming ranking, zero-network guarantee, stored-index-only scoping, and result shape (URL, heading path, [marked] snippet). Annotations already declare readOnly/idempotent/openWorld=false; the description reinforces and enriches rather than contradicting. Query relaxation behavior lives in the schema, so a small gap remains.

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-loads purpose and ranking, then follows with return format, syntax, and prerequisites. Every sentence carries information; slightly dense but 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?

Despite an output schema existing, the description still explains result contents and how to continue to full pages. Combined with the schema, 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.

Parameters3/5

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

Schema coverage is 100%, so parameters are already fully documented including ANDing, relaxation, and limit capping. The description's FTS5 syntax note largely duplicates what the schema states, so it adds little beyond the structured baseline.

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 across all crawled documentation') plus ranking mechanism (BM25 with stemming). Clearly distinguishes itself from read_page and crawl_site, which are named as follow-up/prerequisite tools.

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 routes the agent: 'follow up with read_page for the full page' and 'run crawl_site first for uncrawled sites.' Both alternatives and the conditions selecting them are named, so the agent needn't infer anything.

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

Deploy Server