Skip to main content
Glama

search_manual_docs

Read-only

Find matching passages in the configured Blender manual to answer questions about Blender features, settings, and workflows.

Instructions

Find matching passages in the configured Blender manual.

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

Input Schema

NameRequiredDescriptionDefault
indexNo
queryYes
contextNo
max_resultsNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.0

TDQS

C2.9/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so safety and locality are covered. The description adds only the mild context that the corpus is the 'configured' manual, consistent with a closed-world search, but says nothing about ranking, pagination, or how many passages come back per match.

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?

A single front-loaded sentence with zero filler; the resource is stated immediately. It is efficient, though the brevity tips into under-specification rather than tight completeness.

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

Completeness2/5

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

An output schema exists, so return-value explanation is not required, but the definition leaves the two non-obvious parameters ('index' and 'context') and the choice among three sibling doc-search tools completely unaddressed. For a four-parameter search tool, the description does too little to let an agent invoke it confidently.

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 0%, so all four parameters (query, index, context, max_results) are undocumented in both schema and description. The phrase 'matching passages' hints that results are passage-level, but the meaning of 'index' (which manual index?) and 'context' (surrounding passage window?) is left entirely unexplained, which is a real gap for a 4-param tool.

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?

The description states a specific verb and resource: 'Find matching passages' in 'the configured Blender manual'. That clearly distinguishes it from a code-execution or file-summary tool, though it does not explicitly separate itself from the sibling doc-search tools such as search_api_docs or get_python_api_docs.

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?

There is no when-to-use guidance at all: no statement of when to prefer this over search_api_docs or get_python_api_docs, no prerequisites, and no note about whether the manual must be configured first. The agent must infer the routing decision entirely from the tool name.

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