--- slug: "yuque-plugin" source_type: "readme" source_url: "https://cdn.jsdelivr.net/gh/yuque/yuque-plugin@main/README.md" repo: "https://github.com/yuque/yuque-plugin" source_file: "README.md" branch: "main" --- # 语雀 Claude Code Plugin / Yuque Claude Code Plugin > 让语雀从「文档仓库」进化为「会思考的第二大脑」。 语雀 AI 生态 Marketplace — 为 Claude Code 提供语雀知识库集成能力。 ## 🧠 设计理念 我们相信：**知识的价值不在于存储，而在于流动。** 大多数人的知识库都面临同样的困境——收藏了大量内容，却很少回顾；写了很多笔记，却难以串联；知识越积越多，却越来越难找到需要的那一篇。 语雀 Plugin 的设计目标是：**让 AI 成为你的认知能力扩展**，在知识管理的每个环节提供智能辅助。 ## 📐 架构概览 ``` ┌─────────────────────────────────────────────────┐ │ Claude Code │ │ │ │ ┌───────────────────────────────────────────┐ │ │ │ 语雀 Plugin │ │ │ │ │ │ │ │ ┌─────────────────────────────────────┐ │ │ │ │ │ AI Skills │ │ │ │ │ │ (场景化知识管理工作流) │ │ │ │ │ └──────────────┬──────────────────────┘ │ │ │ │ │ 调用 │ │ │ │ ┌──────────────▼──────────────────────┐ │ │ │ │ │ yuque-mcp server │ │ │ │ │ │ (25 标准化 Tools · 语雀 API 桥接) │ │ │ │ │ └──────────────┬──────────────────────┘ │ │ │ └─────────────────┼─────────────────────────┘ │ └────────────────────┼────────────────────────────┘ │ HTTPS ┌──────▼──────┐ │ 语雀 API │ │ (你的知识库) │ └─────────────┘ ``` - **MCP Server**：底层连接层，提供 25 个标准化 Tools，桥接语雀 API - **Skills**：上层智能层，将 Tools 编排成场景化工作流 - **Plugin**：打包层，一键安装 MCP + Skills，零配置上手 ## 📦 Plugins 本仓库包含两个 Plugin，按使用场景选择安装： | Plugin | 描述 | Skills | 环境变量 | |--------|------|--------|----------| | `yuque-personal` | 个人版 — 个人知识库 AI 集成 | 4 个 | `YUQUE_PERSONAL_TOKEN` | | `yuque-group` | 团队版 — 团队知识库 AI 集成 | 6 个 | `YUQUE_GROUP_TOKEN` | 两个 Plugin 都包含 25 个 MCP Tools（由 [yuque-mcp](https://github.com/yuque/yuque-mcp-server) 提供）。 ### 👤 yuque-personal — 个人版 适合个人用户，操作个人知识库： | Skill | 描述 | |-------|------| | `yuque-personal-smart-search` | 自然语言搜索个人文档，智能摘要回答 | | `yuque-personal-meeting-notes` | 自动生成结构化会议纪要，保存到个人知识库 | | `yuque-personal-weekly-report` | 汇总个人一周文档活动，生成周报 | | `yuque-personal-tech-design` | 根据需求生成技术方案文档 | ### 👥 yuque-group — 团队版 适合团队使用，操作团队知识库（包含个人版全部能力 + 团队专属能力）： | Skill | 描述 | |-------|------| | `yuque-group-smart-search` | 自然语言搜索团队文档，智能摘要回答 | | `yuque-group-meeting-notes` | 自动生成结构化会议纪要，保存到团队知识库 | | `yuque-group-weekly-report` | 汇总团队一周文档活动，生成团队周报 | | `yuque-group-tech-design` | 根据需求生成技术方案文档，保存到团队知识库 | | `yuque-group-onboarding-guide` | 扫描团队知识库，为新成员生成入职阅读指南 | | `yuque-group-knowledge-report` | 分析团队知识库健康度，生成知识管理月报 | ## 🔄 知识管理生命周期 Skills 按知识管理的四个阶段组织，形成完整闭环： ``` 📥 输入 ──→ 🧠 加工 ──→ 📤 输出 ──→ 🔄 维护 │ │ │ │ │ │ │ │ ▼ ▼ ▼ ▼ 捕获知识 深度加工 高效调用 保持鲜活 │ │ └───────────── 闭环 ────────────────┘ ``` --- ## 📥 阶段一：输入 — 捕获一切值得记住的 ### reading-digest · 阅读笔记 将阅读内容转化为结构化笔记，提取核心观点、金句和个人思考。 **使用场景：** - 读完一篇技术文章，想快速沉淀要点 - 读书时随手记录，自动整理成结构化笔记 - 从长文中提取关键信息并归档 **示例对话：** ``` 你：帮我整理这篇文章的阅读笔记 [粘贴文章链接或内容] AI：已为你生成阅读笔记，包含： - 3 个核心观点 - 5 条关键摘录 - 你可能感兴趣的延伸方向 已保存到「阅读笔记」知识库。 ``` ### daily-capture · 碎片想法收集 随时捕获灵感、想法、待办，自动归类整理到语雀。 **使用场景：** - 突然冒出一个产品想法，怕忘记 - 会议中听到一个有启发的观点 - 日常零散思考的快速记录 **示例对话：** ``` 你：记一下：用户反馈说搜索结果排序不够智能，可以考虑加入时间衰减因子 AI：已捕获并归档到今日碎片笔记。 标签：#产品反馈 #搜索优化 ``` --- ## 🧠 阶段二：加工 — 让知识真正内化 ### note-refine · 笔记打磨 对已有笔记进行润色、补充、结构化，提升笔记质量。 **使用场景：** - 草稿笔记写得比较粗糙，想精炼一下 - 给笔记补充背景信息和上下文 - 统一笔记格式和结构 **示例对话：** ``` 你：帮我打磨一下「分布式事务」这篇笔记 AI：已优化： - 补充了 2PC/3PC 的对比表格 - 重新组织了章节结构 - 添加了实际应用场景说明 查看更新：[链接] ``` ### knowledge-connect · 关联发现 分析知识库中的文档，发现潜在的知识关联和主题聚类。 **使用场景：** - 想知道自己的笔记之间有什么隐藏联系 - 写新文章时，找到相关的历史笔记 - 发现知识盲区和可以深入的方向 **示例对话：** ``` 你：分析一下我最近关于「微服务」的笔记有哪些关联 AI：发现 12 篇相关文档，形成 3 个主题簇： 1. 服务拆分策略（4 篇） 2. 数据一致性（5 篇） 3. 可观测性（3 篇） 建议：「数据一致性」和「服务拆分」之间缺少衔接文档。 ``` ### style-extract · 风格分析 分析你的写作风格和表达习惯，帮助保持一致的个人风格。 **使用场景：** - 了解自己的写作特点和偏好 - 让 AI 生成内容时匹配你的风格 - 发现写作中可以改进的模式 **示例对话：** ``` 你：分析一下我的写作风格 AI：基于你最近 50 篇文档的分析： - 偏好短句，平均句长 18 字 - 喜欢用类比解释技术概念 - 常用「本质上」「换句话说」等过渡词 - 代码示例占比高（35% 的文档包含代码块） ``` --- ## 📤 阶段三：输出 — 需要时秒级调用 ### smart-search · 智能搜索 自然语言搜索个人知识库，不只是关键词匹配，而是理解你的意图。 **使用场景：** - 「我之前写过一篇关于 Redis 缓存穿透的笔记」 - 「上个月那个项目的技术方案在哪」 - 模糊记忆的快速定位 **示例对话：** ``` 你：我之前记过一个关于 Go 并发模式的笔记，里面有个 fan-out 的例子 AI：找到了！「Go 并发编程实践」（2024-12-15） 相关段落：Fan-out 模式适用于将任务分发到多个 goroutine... [查看完整文档] ``` ### smart-summary · 多粒度摘要 对文档或文档集生成不同粒度的摘要——一句话、要点、详细总结。 **使用场景：** - 快速回顾一篇长文档的核心内容 - 给别人分享时需要一段简介 - 汇总多篇文档的共同主题 **示例对话：** ``` 你：总结一下我「系统设计」知识库里的所有文档 AI：该知识库共 23 篇文档，核心主题： 📌 一句话：覆盖分布式系统设计的核心模式和实战经验。 📋 要点摘要： - 缓存策略（6 篇）：重点关注一致性和失效策略 - 消息队列（5 篇）：Kafka 和 RabbitMQ 的对比实践 - 数据库（7 篇）：分库分表和读写分离方案 ... ``` --- ## 🔄 阶段四：维护 — 保持知识库常新 ### stale-detector · 过期检测 自动扫描知识库，识别过期、过时或需要更新的内容。 **使用场景：** - 定期清理知识库中的过时信息 - 发现引用了已废弃技术的文档 - 找出长期未更新但仍被引用的笔记 **示例对话：** ``` 你：检查一下我的知识库有哪些内容可能过期了 AI：扫描完成，发现 8 篇可能需要更新的文档： 🔴 高优先级（技术已废弃）： - 「Webpack 3 配置指南」— Webpack 已到 5.x - 「React Class 组件模式」— 建议更新为 Hooks 🟡 中优先级（超过 6 个月未更新）： - 「团队 Git 工作流」— 最后更新 2024-03 ... ``` --- ## 🚀 安装 / Installation ### 1. 添加 Marketplace ```bash # 终端 claude plugin marketplace add yuque/yuque-plugin # 或在 Claude Code 内部 /plugin marketplace add yuque/yuque-plugin ``` ### 2. 安装 Plugin ```bash # 安装个人版 claude plugin install yuque-personal@yuque # 或安装团队版 claude plugin install yuque-group@yuque # 也可以两个都装（使用不同的 Token） ``` ## ⚙️ 配置 / Configuration ### 获取 Token 1. 登录 [语雀](https://www.yuque.com) 2. 进入 **个人设置** → **Token** → **新建**（或直接访问 [Token 设置页](https://www.yuque.com/settings/tokens)） 3. 勾选需要的权限（建议全选读写权限） 4. 复制生成的 Token ### 设置环境变量 根据安装的 Plugin 设置对应的环境变量： ```bash # 个人版 echo 'export YUQUE_PERSONAL_TOKEN="your-personal-token"' >> ~/.zshrc # 团队版 echo 'export YUQUE_GROUP_TOKEN="your-group-token"' >> ~/.zshrc source ~/.zshrc ``` > 💡 个人 Token 和团队 Token 可以是同一个，也可以是不同的。团队 Token 需要有团队级别的访问权限。 ## 🔄 更新 / Upgrade ```bash # 更新个人版 claude plugin update yuque-personal@yuque # 更新团队版 claude plugin update yuque-group@yuque ``` MCP Server（yuque-mcp）通过 `npx -y yuque-mcp@latest` 运行，每次启动自动使用最新版本。 如果返回了搜索结果，说明一切就绪。 ## 🔗 相关项目 / Related Projects - [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) — 语雀 MCP Server（25 Tools） - [yuque-ecosystem](https://github.com/yuque/yuque-ecosystem) — 语雀 AI 生态主页 ## 📄 License MIT