search_api_docs
Search bundled Blender Python API documentation to find ranked matching paragraphs, section breadcrumbs, and relevance scores for a keyword query.
Instructions
Full-text search over the bundled Blender Python API reference.
Returns a ranked list of hits. Each hit has:
path: file path relative to the bundled docs.text: the matching paragraph pluscontextparagraphs 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.
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
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | ||
| query | Yes | ||
| context | No | ||
| max_results | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||