search_by_type
Retrieve documents filtered by a specific category like architecture or bugfix, improving search precision by narrowing results to the selected type.
Instructions
Search filtered by a specific document category. Read-only, no side effects.
Use instead of search_docs() when you know the category — it improves
precision by restricting results to that type only.
Use search_bugfixes() or search_tests() as convenient shortcuts for
those specific categories.
Args:
query: Search query (natural language)
doc_type: Category filter — one of: "architecture", "api",
"bugfix", "best-practice", "setup", "changelog",
"test", "readme", "docs"
top_k: Number of results (default: 5)
project: Target project name (optional)
Returns:
Ranked chunks of the specified type with source, relevance %, and text.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| doc_type | Yes | ||
| top_k | No | ||
| project | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |