search_docs
Search project documentation with a natural-language query to retrieve architecture decisions, past bugs, best practices, and API contracts before changing code.
Instructions
Semantic search over the ENTIRE project knowledge base. Read-only, no side effects.
Use this ALWAYS before writing or changing code to retrieve architecture
decisions, past bugs, best practices, and API contracts.
Prefer search_bugfixes() when debugging a specific error (searches only
bugfix summaries). Use search_by_type() when you know the category.
Use search_tests() when looking for test coverage.
Args:
query: What you want to know (natural language, be specific)
top_k: Number of results (default: 5, increase for broad questions)
project: Target project name (optional, defaults to active project)
Returns:
Ranked doc chunks, each showing source file:line, section heading,
relevance %, doc type, and text. Returns a "no results" message with
a rephrasing suggestion when nothing matches.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| top_k | No | ||
| project | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |