docs-search Skill
搜索自动生成的代码库文档,查找函数签名、API 文档、类定义和代码注释。当用户要求“搜索文档”、“查找文档”、“查询函数”、“查看 API”,或在实现改动前验证正确的签名和模式时使用。
安装方式:把技能目录放入 ~/.claude/skills/(Claude Code)或在 claude.ai 设置中启用;也可复制右侧安装命令一键添加。
技能指令原文(SKILL.md)
AI Maestro Documentation Search
Search your codebase's auto-generated documentation for function signatures, class definitions, API docs, and code comments. Verify correct patterns before writing code. Part of the AI Maestro suite.
Prerequisites
Requires AI Maestro running locally with documentation indexed.
# Install doc tools
git clone https://github.com/23blocks-OS/ai-maestro-plugins.git
cd ai-maestro-plugins && ./install-doc-tools.sh
Core Behavior
Before implementing any code changes, search docs first:
Receive instruction -> Search docs -> Then implement
Commands
Search
| Command | Description |
|---------|-------------|
| docs-search.sh | Semantic documentation search |
| docs-search.sh --keyword | Exact keyword matching |
| docs-find-by-type.sh | Find by type (function, class, module) |
| docs-get.sh | Get full document content |
Index
| Command | Description |
|---------|-------------|
| docs-index.sh [path] | Full index from project |
| docs-index-delta.sh [path] | Delta index (new/modified files only) |
| docs-list.sh | List all indexed documents |
| docs-stats.sh | Index statistics |
Document Types
| Type | Sources |
|------|---------|
| function | JSDoc, RDoc, docstrings |
| class | Class-level comments |
| module | Module/namespace comments |
| interface | TypeScript interfaces |
| component | React/Vue component comments |
| readme | README files |
| guide | docs/ folder content |
Usage Examples
# Semantic search
docs-search.sh "authentication flow"
# Keyword search for specific identifier
docs-search.sh --keyword "UserController"
# Find all class documentation
docs-find-by-type.sh class
# Get full document details
docs-get.sh doc-abc123
# Index your codebase (first time)
docs-index.sh /path/to/project
# Update index after changes
docs-index-delta.sh
Full AI Maestro Experience
This skill is part of the AI Maestro platform, which provides 6 skills for AI agent orchestration: messaging, memory, docs, graph, planning, and agent management.