yuque-personal-smart-summary

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Smart Summary — Yuque Knowledge Base & Document Summarization

智能摘要 — 语雀知识库&文档总结工具

Generate intelligent summaries for an entire knowledge base or a set of documents, helping users quickly understand content landscape, key themes, and important insights.

为整个知识库或一组文档生成智能摘要，帮助用户快速了解内容全貌、核心主题和重要洞察。

When to Use

适用场景

User wants an overview of a knowledge base
User says "帮我总结一下这个知识库", "summarize my repo", "这个库里都有什么"
User wants a summary of multiple related documents
User says "帮我做个知识盘点", "generate a project summary from my docs"
User wants periodic knowledge review

用户想要概览某个知识库的内容
用户说 "帮我总结一下这个知识库", "summarize my repo", "这个库里都有什么"
用户想要总结多份相关文档
用户说 "帮我做个知识盘点", "generate a project summary from my docs"
用户想要定期进行知识复盘

Required MCP Tools

所需MCP工具

All tools are from the

yuque-mcp

server:

```
yuque_list_repos
```
— List personal knowledge bases
```
yuque_get_repo_toc
```
— Get the table of contents of a knowledge base
```
yuque_get_doc
```
— Read full document content
```
yuque_search
```
— Search documents by keyword (for topic-based summaries)

所有工具都来自

yuque-mcp

服务：

```
yuque_list_repos
```
— 列出个人知识库
```
yuque_get_repo_toc
```
— 获取知识库的目录结构
```
yuque_get_doc
```
— 读取文档完整内容
```
yuque_search
```
— 按关键词搜索文档（用于生成主题类摘要）

Workflow

工作流程

Step 1: Identify Scope

步骤1：确定范围

Determine what the user wants summarized:

Option A: Entire knowledge base

Tool: yuque_list_repos
Parameters:
  type: "user"

Then let the user pick a repo, or use the one they specified.

Option B: Specific topic across repos

Tool: yuque_search
Parameters:
  query: "<topic keywords>"
  type: "doc"

Option C: User specifies exact documents Proceed directly to reading them.

明确用户想要总结的内容范围：

选项A：整个知识库

Tool: yuque_list_repos
Parameters:
  type: "user"

之后让用户选择一个知识库，或者直接使用用户指定的知识库。

选项B：跨知识库的特定主题

Tool: yuque_search
Parameters:
  query: "<topic keywords>"
  type: "doc"

选项C：用户指定具体文档 直接进入读取文档的环节。

Step 2: Get Document List

步骤2：获取文档列表

For a knowledge base summary, get the table of contents:

Tool: yuque_get_repo_toc
Parameters:
  repo_id: "<namespace>"

This gives you the full structure — titles, hierarchy, and document slugs.

如果是生成知识库摘要，先获取知识库的目录结构：

Tool: yuque_get_repo_toc
Parameters:
  repo_id: "<namespace>"

这会返回完整的知识库结构——包括标题、层级关系和文档slugs。

Step 3: Sample and Read Documents

步骤3：抽样读取文档

For large knowledge bases (>20 docs), use a sampling strategy:

Read all documents if ≤10 docs
Sample strategically if >10 docs:
- Read the top-level / introductory documents first
- Pick 2-3 documents from each major section
- Prioritize recently updated documents
- Read up to 10-15 documents total

Tool: yuque_get_doc
Parameters:
  repo_id: "<namespace>"
  doc_id: "<slug>"

对于大型知识库（>20 篇文档），使用如下抽样策略：

如果文档数 ≤10，读取全部文档
如果文档数 >10，策略性抽样：
- 优先读取顶层/介绍性文档
- 每个主要板块选取 2-3 篇文档
- 优先选择最近更新的文档
- 总计最多读取 10-15 篇文档

Tool: yuque_get_doc
Parameters:
  repo_id: "<namespace>"
  doc_id: "<slug>"

Step 4: Analyze and Categorize

步骤4：分析与分类

As you read, track:

Main themes — What topics are covered
Content types — Tutorials, references, notes, specs, etc.
Coverage depth — Which areas are well-documented vs sparse
Freshness — How recently content was updated
Connections — How documents relate to each other

读取文档过程中，记录以下信息：

核心主题 — 覆盖了哪些话题
内容类型 — 教程、参考文档、笔记、规范等
覆盖深度 — 哪些领域的文档比较完善，哪些比较匮乏
新鲜度 — 内容最近的更新时间
关联关系 — 文档之间的关联方式

Step 5: Generate Summary

步骤5：生成摘要

Compose the summary in the following format:

markdown

undefined

按照以下格式撰写摘要：

markdown

undefined

📚 知识库摘要：「知识库名称」

概览

文档总数：X 篇
最近更新：YYYY-MM-DD
主要语言：中文/英文/混合

文档总数：X 篇
最近更新：YYYY-MM-DD
主要语言：中文/英文/混合

🗂️ 内容结构

知识库包含以下主要板块：

[板块名称]（X 篇文档）
- [简要描述这个板块的内容]
- 代表文档：文档标题
[板块名称]（X 篇文档）
- [简要描述]
- 代表文档：文档标题
[板块名称]（X 篇文档）
- [简要描述]
- 代表文档：文档标题

知识库包含以下主要板块：

[板块名称]（X 篇文档）
- [简要描述这个板块的内容]
- 代表文档：文档标题
[板块名称]（X 篇文档）
- [简要描述]
- 代表文档：文档标题
[板块名称]（X 篇文档）
- [简要描述]
- 代表文档：文档标题

🔑 核心要点

从整个知识库中提炼的关键信息：

[要点 1]：[2-3 句话概括]
[要点 2]：[2-3 句话概括]
[要点 3]：[2-3 句话概括]
[要点 4]：[2-3 句话概括]
[要点 5]：[2-3 句话概括]

从整个知识库中提炼的关键信息：

[要点 1]：[2-3 句话概括]
[要点 2]：[2-3 句话概括]
[要点 3]：[2-3 句话概括]
[要点 4]：[2-3 句话概括]
[要点 5]：[2-3 句话概括]

📊 知识库健康度

指标	状态
内容覆盖	[全面/有缺口/待补充]
更新频率	[活跃/一般/较少更新]
结构清晰度	[清晰/一般/需要整理]
文档质量	[高/中/参差不齐]

指标	状态
内容覆盖	[全面/有缺口/待补充]
更新频率	[活跃/一般/较少更新]
结构清晰度	[清晰/一般/需要整理]
文档质量	[高/中/参差不齐]

💡 建议

[建议 1：如"XX 板块内容较少，建议补充"]
[建议 2：如"部分文档超过 6 个月未更新，建议检查时效性"]
[建议 3：如"建议添加一篇总览文档串联各板块"]

undefined

[建议 1：如"XX 板块内容较少，建议补充"]
[建议 2：如"部分文档超过 6 个月未更新，建议检查时效性"]
[建议 3：如"建议添加一篇总览文档串联各板块"]

undefined

Step 6: Multi-Document Summary (Alternative)

步骤6：多文档摘要（可选方案）

If summarizing specific documents rather than a whole repo:

markdown

undefined

如果是总结指定文档而非整个知识库：

markdown

undefined

📄 文档摘要

文档列表

#	标题	知识库	更新时间
1	标题	「库名」	YYYY-MM-DD
2	标题	「库名」	YYYY-MM-DD

#	标题	知识库	更新时间
1	标题	「库名」	YYYY-MM-DD
2	标题	「库名」	YYYY-MM-DD

综合摘要

[3-5 段话，综合所有文档的核心内容，突出共同主题和关键信息]

各文档要点

1. [文档标题]

[要点 1]
[要点 2]
[要点 3]

[要点 1]
[要点 2]
[要点 3]

2. [文档标题]

[要点 1]
[要点 2]
[要点 3]

[要点 1]
[要点 2]
[要点 3]

文档间关联

[文档 A 和文档 B 在 XX 方面互相补充]
[文档 C 是文档 A 的深入展开]

undefined

[文档 A 和文档 B 在 XX 方面互相补充]
[文档 C 是文档 A 的深入展开]

undefined

Guidelines

使用规范

Always answer in the same language the user used (Chinese or English)
For large knowledge bases, be upfront about sampling: "知识库共有 X 篇文档，我抽样阅读了 Y 篇进行分析"
Focus on actionable insights, not just listing document titles
Highlight gaps and opportunities — what's missing is as valuable as what's there
Include document links so users can dive deeper into any topic
This skill summarizes personal repos — for team repos, use the corresponding skill in the
```
yuque-group
```
plugin

始终使用和用户提问相同的语言回复（中文或英文）
针对大型知识库，提前告知用户抽样情况："知识库共有 X 篇文档，我抽样阅读了 Y 篇进行分析"
聚焦可落地的洞察，不要只罗列文档标题
突出缺口和优化空间——缺失的内容和已有的内容同样有价值
包含文档链接，方便用户深入了解任意主题
本工具仅用于总结个人知识库——如需总结团队知识库，请使用
```
yuque-group
```
插件中的对应工具

Error Handling

错误处理

Situation	Action
`yuque_list_repos` returns empty	Ask user for the exact repo name or ID
`yuque_get_repo_toc` returns empty	Inform user the knowledge base appears to be empty
`yuque_get_doc` fails (404)	Skip this doc, note it may have been deleted
`yuque_get_doc` fails (403)	Tell user they may lack permission to access this doc
API timeout	Retry once, then inform user of connectivity issue
Knowledge base has >50 docs	Sample 10-15 docs, clearly state the sampling approach

场景	处理方式
`yuque_list_repos` 返回空结果	询问用户具体的知识库名称或ID
`yuque_get_repo_toc` 返回空结果	告知用户该知识库看起来是空的
`yuque_get_doc` 调用失败（404）	跳过该文档，提示该文档可能已被删除
`yuque_get_doc` 调用失败（403）	告知用户可能没有权限访问该文档
API超时	重试一次，之后告知用户连接存在问题
知识库文档数>50	抽样10-15篇文档，明确告知用户抽样策略