Skip to main content
Glama

BlockVectra Docs

by com.blockvectra
OverviewDiscussionsAdmin

Search Documentation

search_docs
Read-only

Search documentation pages using keywords against page title, relative path, and first-paragraph summary in the lightweight static search index. Returns matching page titles, paths, and summaries.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
langNoLanguage to search: 'en' for English or 'zh' for Chinese. Defaults to 'en'.
limitNoMaximum number of search results to return (1-20, default 5).
queryYesKeywords to search for in documentation titles, paths, and summaries.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageNo
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "message": {
+      "type": "string"
+    },
+    "results": {
+      "items": {
+        "properties": {
+          "path": {
+            "type": "string"
+          },
+          "summary": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "title",
+          "path",
+          "summary"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "results"
+  ],
+  "type": "object"
+}
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful behavioral context beyond annotations: it searches a lightweight static index against title, relative path, and first-paragraph summary, and returns specific fields. It does not discuss rate limits or pagination, but that is not required given the annotation coverage and simple read-only nature.

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?

Two sentences with zero waste. Purpose and search targets are front-loaded, and the return information follows immediately. Every clause contributes to selecting or invoking the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple three-parameter read-only search tool with 100% schema coverage, an output schema, and safety annotations, the description is largely complete. It explains what is searched and what is returned. The only notable gap is routing relative to sibling tools like list_docs and read_doc, which keeps it from being fully complete.

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 description coverage is 100%, so the input schema already documents query, lang, and limit fully. The description does not add syntax, defaults, or constraints beyond the schema for any parameter. Baseline 3 is appropriate when the schema carries parameter semantics.

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: search documentation pages using keywords. Names the exact search targets (title, relative path, first-paragraph summary) and return fields (titles, paths, summaries). This distinguishes it from sibling list_docs and read_doc without needing to open their schemas.

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

Usage Guidelines2/5

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

The description implies a keyword-search scenario but gives no explicit when-to-use guidance. It does not mention alternatives like list_docs or read_doc, nor when this tool should be preferred over browsing or reading a specific page. No exclusions or routing cues are provided.

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

All BlockVectra Docs toolsInspect
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