Skip to content

Commit 9ec9805

Browse files
chen201724babydog-ai
andauthored
docs: rewrite README as ecosystem overview (#21)
* docs: rewrite README as ecosystem overview * docs: remove hardcoded numbers, generalize plugin description * docs: generalize plugin description, avoid hardcoding tool names * fix: correct plugin description, use "AI assistant" instead of "coding assistant" --------- Co-authored-by: babydog-ai <willchen.babydog@gmail.com>
1 parent da7e73a commit 9ec9805

1 file changed

Lines changed: 54 additions & 19 deletions

File tree

README.md

Lines changed: 54 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,67 @@
1-
# Yuque AI Ecosystem
1+
# Yuque AI Ecosystem — 语雀 AI 生态
22

3-
> MCP Server, Skills & Plugin for Yuque (语雀)
3+
> MCP Server · Skills · Plugin — 让 AI 无缝连接语雀,释放知识的力量。
44
5-
让 AI 助手无缝连接语雀,释放知识的力量。
5+
🌐 [官网](https://yuque.github.io/yuque-ecosystem/)
66

7-
## 🏗 Architecture
7+
## 🏗 生态概览
88

9-
- **MCP Server** — 底层连接层,25 个标准化 Tools
10-
- **Skills** — 场景化工作流,6 个精选方案
11-
- **Plugin** — 编辑器深度集成(Coming Soon)
9+
语雀 AI 生态由三层组成,从底层连接到上层场景,逐层构建:
1210

13-
## 🚀 Quick Start
11+
```
12+
┌─────────────────────────────────────────────┐
13+
│ 🔌 Plugin — AI 助手插件集成 │
14+
├─────────────────────────────────────────────┤
15+
│ 🎯 Skills — 场景化 AI 工作流 │
16+
├─────────────────────────────────────────────┤
17+
│ ⚙️ MCP Server — 标准化 Tools │
18+
└─────────────────────────────────────────────┘
19+
```
1420

15-
```bash
16-
# 1. 获取语雀 Token
17-
# https://www.yuque.com/settings/tokens
21+
### ⚙️ [MCP Server](https://github.com/yuque/yuque-mcp-server)
1822

19-
# 2. 添加 MCP Server
20-
claude mcp add yuque-mcp -- npx -y yuque-mcp --token=YOUR_TOKEN
23+
底层连接层,提供标准化 Tools,覆盖语雀知识库的读写、搜索、管理等全部能力。
2124

22-
# 3. 开始使用!
23-
```
25+
- npm:[yuque-mcp](https://www.npmjs.com/package/yuque-mcp)
26+
27+
### 🎯 [Skills](https://github.com/yuque/yuque-plugin)
28+
29+
场景化 AI 工作流,将多个 Tools 编排成开箱即用的解决方案。
30+
31+
- **个人版**:覆盖知识管理全生命周期(📥 输入 → 🧠 加工 → 📤 输出 → 🔄 维护)
32+
- **团队版**:Coming Soon
33+
34+
### 🔌 [Plugin](https://github.com/yuque/yuque-plugin)
35+
36+
AI 助手插件集成,一键配置 MCP Server + Skills,开箱即用。当前支持 Claude Code。
37+
38+
## 📋 个人版 Skills
39+
40+
| 阶段 | Skill | 说明 |
41+
|------|-------|------|
42+
| 📥 输入 | 📖 阅读笔记 | 阅读文章后自动提取核心观点,生成结构化阅读笔记 |
43+
| 📥 输入 | 💡 碎片捕捉 | 随时记录灵感想法,定期自动归类整理成主题笔记 |
44+
| 🧠 加工 | ✨ 笔记打磨 | 把粗糙笔记打磨成高质量文档,优化结构与表达 |
45+
| 🧠 加工 | 🕸️ 知识关联 | 分析文档间隐藏联系,构建交叉引用知识网络 |
46+
| 🧠 加工 | ✍️ 风格提取 | 分析写作风格生成画像,保持一致文风 |
47+
| 📤 输出 | 🔍 智能搜索 | 自然语言搜索知识库,秒找关键内容 |
48+
| 📤 输出 | 📋 智能摘要 | 对文档或知识库生成不同粒度的摘要 |
49+
| 🔄 维护 | 🔎 过期检测 | 扫描发现过期文档,生成健康报告 |
50+
51+
## 🚀 快速开始
52+
53+
- **使用 MCP Server** → 查看 [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) 获取配置指南
54+
- **使用 Plugin** → 查看 [yuque-plugin](https://github.com/yuque/yuque-plugin) 一键安装
55+
- **浏览官网**[yuque.github.io/yuque-ecosystem](https://yuque.github.io/yuque-ecosystem/)
2456

25-
## 📦 Links
57+
## 📦 相关仓库
2658

27-
- [npm: yuque-mcp](https://www.npmjs.com/package/yuque-mcp)
28-
- [Website](https://yuque.github.io/yuque-ecosystem/)
59+
| 仓库 | 说明 |
60+
|------|------|
61+
| [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) | MCP Server,底层连接层 |
62+
| [yuque-plugin](https://github.com/yuque/yuque-plugin) | Plugin + Skills,AI 助手集成与场景化工作流 |
63+
| [yuque-ecosystem](https://github.com/yuque/yuque-ecosystem) | 本仓库,生态官网 |
2964

3065
## License
3166

32-
MIT © yuque
67+
MIT © [Yuque](https://www.yuque.com)

0 commit comments

Comments
 (0)