Skip to main content
Glama

search_api_docs

Read-only

Search configured Blender Python API documentation to find relevant passages and retrieve context for coding, debugging, or reference tasks.

Instructions

Find matching passages in the configured Blender Python API documentation.

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_api_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.7/5.0
Behavior2/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 and the description needn't repeat it. What it omits is behavior that matters here: what the 'configured' documentation means (which index is searched, whether it can be switched), and what the context/max_results knobs do to the result set. The only added value is confirming the corpus is local Blender API docs.

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 tight sentence with no filler, and the resource is placed where it is read first. It is appropriately sized; the issue is under-specification, not verbosity.

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 shape is covered elsewhere. But a four-parameter search tool with 0% schema coverage needs the description to carry parameter meaning, and it does not — leaving an agent to guess at 'index' and 'context' semantics, which directly affect results.

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% and all four parameters (query, index, context, max_results) are bare titles with defaults. The description explains none of them — not which index 'index' selects, not whether 'context' means surrounding passages or lines of surrounding code. Only the required 'query' param is loosely implied by 'Find matching passages'.

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 names a specific verb ('Find matching passages') and a specific resource ('the configured Blender Python API documentation'), which is enough to know it is a passage-retrieval search tool. It stops short of explicitly distinguishing itself from the sibling get_python_api_docs or search_manual_docs, though 'API documentation' implicitly separates it from manual-doc search.

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, no exclusions, and no named alternative. An agent cannot tell from this sentence whether to prefer it over get_python_api_docs (full doc pages) or search_manual_docs, so the choice must be inferred from tool names alone.

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