关于 yuque-personal-smart-search
yuque-personal-smart-search 是用于检索个人语雀知识库并整理带引用回答的技能。它从自然语言提取简短关键词,再读取相关文档进行归纳。
主要功能
- 01处理自然语言查询
- 02按关键词搜索文档
- 03读取完整文档内容
- 04筛选并排序相关结果
- 05回答附带来源引用
适用场景
- 01查找个人语雀文档中的流程
- 02依据已保存笔记回答问题
- 03定位特定文档或信息
MCP 相关
该技能使用 yuque-mcp 服务提供的 yuque_search 和 yuque_get_doc 工具搜索并读取文档;未说明其自身提供 MCP 服务。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ yuque/ yuque-plugin --skill yuque-personal-smart-search安装后在 Claude Code 中输入/yuque-personal-smart-search确认已加载。
详细介绍
智能搜索——语雀个人知识库搜索与问答
使用自然语言搜索个人语雀知识库,阅读相关文档,并结合参考资料生成清晰的答案。
适用场景
- 用户提出的问题可能能在其个人语雀文档中找到答案
- 用户想在自己的知识库中查找特定信息
- 用户说“搜一下我的文档”“search my Yuque”“我的知识库里有没有……”
必需的 MCP 工具
所有工具均来自 yuque-mcp 服务:
yuque_search— 按关键词搜索文档yuque_get_doc— 按 slug/id 读取完整文档内容
工作流
步骤 1:提取搜索关键词
从用户的自然语言查询中提取 1-3 个简洁的中文关键词。语雀搜索使用简短、具体的词语效果最佳。
示例:
- “我的部署流程文档在哪?” → 关键词:
部署流程 - “How do I handle error logging?” → 关键词:
错误日志或日志处理 - “我之前写的技术评审笔记” → 关键词:
技术评审
步骤 2:搜索文档
使用提取的关键词调用 yuque_search:
Tool: yuque_search
Parameters:
query: "<keywords>"
type: "doc"
如果搜索没有返回结果:
- 尝试其他关键词(同义词、更宽泛的词语)
- 尝试拆分复合词(例如,“部署流程” → “部署”或“流程”)
- 如果仍然没有结果,坦诚告知用户:“在你的语雀知识库中未找到相关文档,建议尝试其他关键词或确认文档是否存在。”
步骤 3:筛选并排序结果
根据以下条件,从搜索结果中选出最相关的前 3-5 篇文档:
- 标题与查询的相关性
- 文档更新时间(优先选择较新的文档)
- 仓库上下文(重点关注用户的个人仓库)
步骤 4:读取文档内容
获取每篇选定文档的完整内容:
Tool: yuque_get_doc
Parameters:
repo_id: "<namespace>" # e.g., "username/my-notes" (from search result's book.namespace)
doc_id: "<slug>" # e.g., "api" (from search result's target.slug)
注意:搜索结果包含嵌套数据。提取以下关键字段:
target.slug→ 用作doc_idtarget.book.namespace→ 用作repo_idtarget.title→ 文档标题target.updated_at→ 最后更新时间
最多读取 3 篇文档。如果第一篇文档已完整回答问题,可以跳过其余文档。
步骤 5:综合并作答
按以下格式组织答案:
## 回答
[直接回答用户的问题,2-4 句话,简洁明了]
## 关键要点
- **要点 1**:[从文档中提取的关键信息]
- **要点 2**:[从文档中提取的关键信息]
- **要点 3**:[从文档中提取的关键信息]
## 参考文档
1. [文档标题](文档链接) — 来自「知识库名称」,更新于 YYYY-MM-DD
2. [文档标题](文档链接) — 来自「知识库名称」,更新于 YYYY-MM-DD
指南
- 始终使用与用户相同的语言作答(中文或英文)
- 相关时引用文档中的具体内容,使用
>引用块 - 如果文档内容存在冲突,指出差异并说明哪篇文档更新
- 如果只找到部分答案,说明已找到的内容以及缺失的信息
- 切勿编造文档中没有的信息
- 附上文档链接,方便用户阅读完整来源
- 此技能搜索用户的个人知识库;对于团队知识库,请使用
yuque-group插件中的smart-search技能
错误处理
| 情况 | 操作 |
|---|---|
yuque_search 返回空结果 | 尝试其他关键词,然后告知用户 |
yuque_get_doc 失败(404) | 跳过此文档,并说明该文档可能已被删除 |
yuque_get_doc 失败(403) | 告知用户其可能没有访问此文档的权限 |
| API 超时 | 重试一次,然后告知用户存在连接问题 |
| 结果过多 | 重点查看相关性最高的前 3 条,并说明还有更多结果 |
评论
支持 Markdown