Documentation Search Skill logo

Documentation Search Skill

打开

AI Maestro 的文档搜索 Skill:让 Agent 写代码前先检索自动生成的代码库文档,确认函数签名、类与 API,支持语义与关键词检索。

分享:
查看替代方案

概述

Documentation Search Skill 是 AI Maestro 的 docs-search Skill。AI Maestro 是 23blocks 开源(MIT)的多 Agent 编排面板,提供持久记忆、消息和多机协作。它会从你的代码生成可检索的文档,而这个 Skill 要求 Agent 在实现任何东西之前先查文档,确认已有的函数签名、API 和模式,让新代码与现有代码保持一致。用 Skill 自己的话说:先核对签名再写调用,而不是等类型报错之后。

该 Skill 发布在 ai-maestro-plugins,需要 AI Maestro 和 Bash 权限,命令会从 tmux 会话自动识别 Agent ID。

命令

命令 用途
docs-search.sh <query> 语义检索文档
docs-search.sh --keyword <term> 关键词/精确匹配
docs-find-by-type.sh <type> 按类型查找(函数、类、模块等)
docs-get.sh <doc-id> 获取完整文档
docs-list.sh 列出所有已索引文档
docs-stats.sh 索引统计
docs-index.sh [project-path] 全量索引项目
docs-index-delta.sh [project-path] 只索引新增和修改的文件

强制的行为

  • 一收到任务就检索文档,搜索用户提到的术语。
  • 调用不熟悉的函数前先查文档,新建组件前先找已有模式。
  • 不因为「任务简单」而跳过,也不等用户提醒。

快速上手

安装 AI Maestro(包含 Claude Code 插件与 CLI 脚本):

curl -fsSL https://raw.githubusercontent.com/23blocks-OS/ai-maestro/main/scripts/remote-install.sh | sh

然后用 docs-index.sh /path/to/project 建立索引,之后用 docs-index-delta.sh 保持更新。

适用场景

  • 大型或陌生代码库中,靠猜签名容易出现类型错误。
  • 让多个 Agent 遵循相同的内部 API。

局限

  • 效果取决于项目生成的文档和代码注释质量。
  • 依赖 AI Maestro,脚本无法独立运行。

常见问题

每次改动后都要重新索引吗?

使用 docs-index-delta.sh,只处理新增和修改的文件。

替代方案

  • Serena:通过 MCP 为 Agent 提供 IDE 级语义代码检索。
  • 不使用 AI Maestro 时,Claude Code 也能直接搜索和阅读源码。

相关 Skill

其他 AI Maestro Skill:Memory Search、Graph Query、Agent Messaging。更多内容见 Skills 分类 与 文档标签。

评论

还没有评论。成为第一个评论的人!