Skip to main content
Glama

BlockRazor Docs

searchDocumentation

Read-onlyIdempotent

Search across the documentation to find relevant information, code examples, API references, and guides. Use this tool when you need to answer questions about BlockRazor, find specific documentation, understand how features work, or locate implementation details. The search returns contextual content with titles and direct links to the documentation pages.

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": "searchDocumentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYes
languageNoThe language the user is writing in. Pass it whenever you know it, so results come from the documentation in that language. Defaults to "en".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / language
      Added value: +{
      +  "description": "The language the user is writing in. Pass it whenever you know it, so results come from the documentation in that language. Defaults to \"en\".",
      +  "enum": [
      +    "zh-tw",
      +    "en"
      +  ],
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so safety is covered. The description adds value the annotations cannot: what comes back ('contextual content with titles and direct links'), which matters since there is no output schema. It omits result limits, ranking behavior, and whether queries are semantic or keyword-based.

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?

Three sentences, front-loaded with the core action, then usage triggers, then return shape. Slight redundancy between 'find relevant information' and 'find specific documentation', but no meaningful filler.

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 two-parameter read-only search with no output schema, the definition covers purpose, usage, and return format adequately, and annotations carry the safety profile. The main residual gap is the undocumented required 'query' parameter and the unmentioned language option.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

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

Schema description coverage is only 50%: the 'language' parameter is well documented in the schema, but the required 'query' parameter has no description anywhere. The description never mentions query formulation, scope, or the language option, so it does not compensate for the gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Search across the documentation') and enumerates what it covers: relevant information, code examples, API references, and guides. It implicitly distinguishes itself from getPage by noting results are titles plus direct links rather than page content, but no sibling is named explicitly.

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

Usage Guidelines4/5

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

Gives concrete when-to-use conditions: answering questions about BlockRazor, finding specific documentation, understanding features, locating implementation details. There are no when-not-to-use clauses or named alternatives (e.g., askQuestion or getPage), so it stops short of full routing guidance.

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