鱼皮AI导航
鱼皮AI导航
  • 主页
  • 社区
  • AI工具
  • AI知识库
  • AI提示词
  • MCP
  • Skills
  • AI学习资源
  • AI资讯
  • GitHub开源
登录/注册

docs-search

主动检索自动生成的代码文档,覆盖函数签名、类定义、API说明和源码注释,在执行任何用户指令前优先获取准确上下文,确保实现符合既有规范与设计意图。

文档处理
访问 GitHub
文档Skills.MD
name
AI Maestro Documentation Search
description
PROACTIVELY search auto-generated documentation when receiving ANY user instruction. Search for function signatures, API documentation, class definitions, and code comments BEFORE implementing anything. Your codebase documentation is valuable - use it first.
allowed-tools
Bash

AI Maestro Documentation Search

CRITICAL: AUTOMATIC BEHAVIOR - READ THIS FIRST

THIS IS NOT OPTIONAL. THIS IS YOUR DEFAULT BEHAVIOR.

When the user gives you ANY instruction or task, you MUST FIRST search documentation for:

  • Function signatures - What are the parameters and return types?
  • Class documentation - What methods and properties exist?
  • API documentation - How should this endpoint work?
  • Code comments - What did the author intend?

DO NOT:

  • Start implementing before checking documentation
  • Assume you know the function signature without checking
  • Skip doc search because "it's a simple task"
  • Wait for the user to ask you to check docs

ALWAYS:

  • Search docs IMMEDIATELY when you receive a task
  • Search for terms and concepts the user mentions
  • Check documentation before calling unfamiliar functions
  • Look for patterns before creating new components

The Rule: Receive Instruction → Search Docs → Then Proceed

▼
text
复制代码
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:

▼
bash
复制代码
# IMMEDIATELY run: docs-search.sh "PaymentService" docs-find-by-type.sh class

Example - User mentions a function:

▼
bash
复制代码
# IMMEDIATELY run: docs-search.sh "validateUser" docs-search.sh --keyword "authenticate"

Available Commands

All commands auto-detect your agent ID from the tmux session.

Search Commands

CommandDescription
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.shList all indexed documents
docs-stats.shGet documentation index statistics

Indexing Commands

CommandDescription
docs-index.sh [project-path]Index documentation from project

What to Search Based on User Instruction

User SaysIMMEDIATELY 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 namedocs-search.sh "<name>" --keyword

Usage Examples

Search for Documentation

▼
bash
复制代码
# 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 by Document Type

▼
bash
复制代码
# 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

Get Full Document

▼
bash
复制代码
# After finding a doc ID from search results docs-get.sh doc-abc123 # Shows full content including all sections

List and Stats

▼
bash
复制代码
# List all indexed documents docs-list.sh # Get index statistics docs-stats.sh

Index Documentation

▼
bash
复制代码
# Index current project (auto-detected from agent config) docs-index.sh # Index specific project docs-index.sh /path/to/project

Document Types

The following document types are recognized:

TypeDescriptionSources
functionFunction/method documentationJSDoc, RDoc, docstrings
classClass documentationClass-level comments
moduleModule/namespace documentationModule comments
interfaceInterface/type documentationTypeScript interfaces
componentReact/Vue component documentationComponent comments
constantDocumented constantsConstant comments
readmeREADME filesREADME.md, README.txt
guideGuide/tutorial documentationdocs/ folder

Integration with Other Skills

Docs-search works best when combined with other skills:

Combined Search Pattern (RECOMMENDED)

When you receive ANY user instruction:

▼
bash
复制代码
# 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:

  • Memory: What was discussed before?
  • Docs: What does the documentation say?
  • Graph: What is the code structure?

Why This Matters

Without searching docs first, you will:

  • Use wrong function signatures (then get runtime errors)
  • Miss existing implementations (then duplicate code)
  • Violate documented patterns (then create inconsistency)
  • Misunderstand APIs (then build the wrong thing)

Doc search takes 1 second. Redoing work takes hours.

Error Handling

Script not found:

  • Check PATH: which docs-search.sh
  • Verify scripts installed: ls -la ~/.local/bin/docs-*.sh
  • Scripts are installed to ~/.local/bin/ which should be in your PATH
  • If not found, run: ./install-docs-tools.sh

API connection fails:

  • Ensure AI Maestro is running: curl http://127.0.0.1:23000/api/hosts/identity
  • Ensure documentation has been indexed: docs-stats.sh
  • If no docs indexed, run: docs-index.sh

Documentation is empty:

  • Check project has documented code (JSDoc, docstrings, comments)
  • Verify project path is correct
  • Re-index with: docs-index.sh /path/to/project

No results found:

  • Inform the user: "No documentation found for X - proceeding with code analysis, but documentation may need to be generated."

Installation

If commands are not found:

▼
bash
复制代码
./install-docs-tools.sh

This installs scripts to ~/.local/bin/.

文档处理

快捷安装

复制到终端去安装 Skill

npxskillsadd23blocks-OS/ai-maestro--skill"docs-search"
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
🔥热门工具
朱雀AI检测朱雀AI检测
朱雀AI检测助手朱雀AI检测助手
LovartLovart
老鱼简历老鱼简历
WritePass官网WritePass官网
面多多面多多
CursorCursor
星月写作星月写作
朱雀AI检测助手朱雀AI检测助手
零感AI零感AI
Skills 推荐
docx
支持专业级 Word 文档的全生命周期处理,包括从零创建结构化文档、精准编辑内容、管理修订痕迹与批注、提取纯文本或原始 XML 数据、转换为 PDF 或图像用于视觉分析,适用于法律、学术及企业场景下的高保真文档协作与自动化处理。
create-skill-file
指导 Claude 创建结构清晰、易于发现和执行的 SKILL.md 文件,涵盖命名规范、文件组织、内容编写及质量检查全流程,强调简洁性、场景化触发和渐进式信息呈现。
documentation-criteria
规范各类技术文档的生成流程与内容标准,依据变更规模和影响范围自动判断需产出的文档类型及顺序,明确每类文档的核心要素、边界划分与协同关系,确保从需求定义到落地实施的全链路可追溯、可验证、可复用。
research
面向技术方案的深度调研能力,通过网络搜索、GitHub 仓库分析和多源证据采集,支持在实施前全面评估技术选型,确保每个推荐方案均基于官方文档、活跃代码库及真实应用案例等至少两项可靠依据。
code-documentation
生成清晰的代码文档,涵盖 API 说明、项目结构和架构决策,通过示例代码与注释帮助开发者理解实现逻辑,确保技术信息准确且易于维护。