From ai-maestro
Searches auto-generated codebase documentation for function signatures, API documentation, class definitions, and code comments. Use when the user asks to "search docs", "find function", "check API", or before implementing anything to understand existing patterns.
How this skill is triggered — by the user, by Claude, or both
Slash command
/ai-maestro:docs-searchThis skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
**THIS IS NOT OPTIONAL. THIS IS YOUR DEFAULT BEHAVIOR.**
THIS IS NOT OPTIONAL. THIS IS YOUR DEFAULT BEHAVIOR.
When the user gives you ANY instruction or task, you MUST FIRST search documentation for:
DO NOT:
ALWAYS:
1. User asks you to do something
2. IMMEDIATELY search docs for relevant context
3. NOW you know the correct signatures and patterns
4. NOW you can implement correctly the first time
Example - User asks to modify a service:
# IMMEDIATELY run:
docs-search.sh "PaymentService"
docs-find-by-type.sh class
Example - User mentions a function:
# IMMEDIATELY run:
docs-search.sh "validateUser"
docs-search.sh --keyword "authenticate"
All commands auto-detect your agent ID from the tmux session.
| Command | Description |
|---|---|
docs-search.sh <query> | Semantic search through documentation |
docs-search.sh --keyword <term> | Keyword/exact match search |
docs-find-by-type.sh <type> | Find docs by type (function, class, module, etc.) |
docs-get.sh <doc-id> | Get full document with all sections |
docs-list.sh | List all indexed documents |
docs-stats.sh | Get documentation index statistics |
| Command | Description |
|---|---|
docs-index.sh [project-path] | Full index documentation from project |
docs-index-delta.sh [project-path] | Delta index - only index new and modified files |
| User Says | IMMEDIATELY Search |
|---|---|
| "Create a service for X" | docs-search.sh "service", docs-find-by-type.sh class |
| "Call the Y function" | docs-search.sh "Y", docs-search.sh --keyword "Y" |
| "Implement authentication" | docs-search.sh "authentication", docs-search.sh "auth" |
| "Fix the Z method" | docs-search.sh "Z" --keyword, docs-find-by-type.sh function |
| Any API/function name | docs-search.sh "<name>" --keyword |
# Semantic search - finds conceptually related docs
docs-search.sh "authentication flow"
docs-search.sh "how to validate user input"
docs-search.sh "database connection pooling"
# Keyword search - exact term matching
docs-search.sh --keyword "authenticate"
docs-search.sh --keyword "UserController"
# Find all function documentation
docs-find-by-type.sh function
# Find all class documentation
docs-find-by-type.sh class
# Find all module/concern documentation
docs-find-by-type.sh module
# Find all interface documentation
docs-find-by-type.sh interface
# After finding a doc ID from search results
docs-get.sh doc-abc123
# Shows full content including all sections
# List all indexed documents
docs-list.sh
# Get index statistics
docs-stats.sh
# Index current project (auto-detected from agent config)
docs-index.sh
# Index specific project
docs-index.sh /path/to/project
# Delta index - only process new and modified files (much faster)
docs-index-delta.sh
# Delta index a specific project
docs-index-delta.sh /path/to/project
Use delta indexing for incremental updates after code changes. Use full docs-index.sh for a complete re-index.
The following document types are recognized:
| Type | Description | Sources |
|---|---|---|
function | Function/method documentation | JSDoc, RDoc, docstrings |
class | Class documentation | Class-level comments |
module | Module/namespace documentation | Module comments |
interface | Interface/type documentation | TypeScript interfaces |
component | React/Vue component documentation | Component comments |
constant | Documented constants | Constant comments |
readme | README files | README.md, README.txt |
guide | Guide/tutorial documentation | docs/ folder |
Docs-search works best when combined with other skills:
When you receive ANY user instruction:
# 1. Search your memory first
memory-search.sh "topic"
# 2. Search documentation
docs-search.sh "topic"
# 3. Check code structure
graph-describe.sh ComponentName
This gives you complete context:
Without searching docs first, you will:
Doc search takes 1 second. Redoing work takes hours.
This skill relies on an internal helper script that provides shared utility functions:
docs-helper.sh - Sourced by the docs-*.sh tool scripts. Provides documentation-specific API functions (docs_query, docs_index) and initialization logic. Located alongside the tool scripts in ~/.local/bin/ (installed) or plugin/src/scripts/ (source). If tool scripts fail with "common.sh not found", re-run the installer (./install-doc-tools.sh).Script not found:
which docs-search.shls -la ~/.local/bin/docs-*.sh~/.local/bin/ which should be in your PATH./install-doc-tools.shAPI connection fails:
curl http://127.0.0.1:23000/api/hosts/identitydocs-stats.shdocs-index.shDocumentation is empty:
docs-index.sh /path/to/projectNo results found:
If commands are not found:
./install-doc-tools.sh
This installs scripts to ~/.local/bin/.
npx claudepluginhub 23blocks-os/ai-maestro-plugins --plugin ai-maestroManages OpenAI Codex CLI docs: scraping from llms.txt, keyword/NL search, doc_id/alias resolution, index maintenance via Python/Bash scripts.
Discovers Logic IDs and file paths from semantic docs/semantic/ for efficient codebase exploration. Use /discover FEATURE for lookups, keyword search, --prime for business index before Glob/Grep/Explore.
Uses docpull tools to fetch, index, and search live docs for fast-moving libraries like Next.js, FastAPI, LangChain, React when answering 'how to X' or API questions.