Skip to main content
Glama

search_manual_docs

Read-only

Search the bundled Blender user manual to find relevant sections, ranked results with context and breadcrumbs for quick reference.

Instructions

Full-text search over the bundled Blender user manual.

Returns a ranked list of hits. Each hit has:

  • path: file path relative to the bundled docs.

  • text: the matching paragraph plus context paragraphs on either side.

  • breadcrumb: the section path containing the hit (Section > Sub-section > ...).

  • index: the hit's position in the result list.

  • score: a relevance score; higher is better.

The query is tokenised on whitespace and matched case-insensitively. Every token must appear somewhere in the paragraph body, the file path, or an enclosing section title - in any order. Common English stop-words (the, a, how, to, ...) are dropped, so natural phrasings like "how to bake" work as expected. Regular expressions are not supported.

Use context to pull more surrounding paragraphs into each hit (symmetric, default 0). Use index with the position of a previous hit (same query) to get that hit alone with its text widened to its enclosing section.

Read-only; consults bundled RST files only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexNo
queryYes
contextNo
max_resultsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true. The description goes well beyond that by explaining query matching semantics, case-insensitivity, stop-word dropping, lack of regex support, the symmetric context widening, the index re-query behavior, and explicitly stating 'Read-only; consults bundled RST files only.' No contradiction with annotations exists.

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?

The description is well-organized: front-loaded purpose, bulleted return fields, then crisp parameter and matching semantics. Every sentence adds information, and there is no filler or redundancy.

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 tool's moderate complexity, the description covers the purpose, matching behavior, result fields, and the two non-obvious parameters (context and index). The output schema exists, so return-value details are already structurally available. The only minor omission, explicit max_results behavior, is inconsequential.

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 description coverage is 0%, so the description carries the parameter-documentation burden. It clearly explains query tokenization, the context parameter's symmetric widening, and the index parameter's role in retrieving a previous hit alone. max_results is not explicitly described, but its meaning is self-evident from the name.

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?

The description opens with a specific verb and resource: 'Full-text search over the bundled Blender user manual.' This clearly distinguishes it from the sibling search_api_docs, which targets API documentation. The bulleted return fields further clarify exactly what the tool produces.

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

Usage Guidelines3/5

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

The description gives detailed behavior context, such as tokenization, stop-word removal, and the use of context/index. However, it never explicitly tells the agent when to choose this tool over search_api_docs or other siblings, and it names no alternatives or exclusion conditions. Usage is implied by the resource name rather than stated.

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