yuque-personal-smart-summary

Smart Summary — Yuque ナレッジベースとドキュメントの要約

ナレッジベース全体または一連のドキュメントのインテリジェントな要約を生成し、ユーザーが内容の全体像、主要なテーマ、重要な洞察をすばやく把握できるようにします。

使用する場面

• ユーザーがナレッジベースの概要を知りたがっている
• ユーザーが「帮我总结一下这个知识库」、「summarize my repo」、「这个库里都有什么」と言う
• ユーザーが関連する複数のドキュメントの要約を求めている
• ユーザーが「帮我做个知识盘点」、「generate a project summary from my docs」と言う
• ユーザーが定期的なナレッジレビューを希望している

必要な MCP ツール

すべてのツールは yuque-mcp サーバーのものです。

• yuque_list_repos — 個人のナレッジベースを一覧表示する
• yuque_get_repo_toc — ナレッジベースの目次を取得する
• yuque_get_doc — ドキュメントの全文を読み取る
• yuque_search — キーワードでドキュメントを検索する（トピック別の要約に使用）

ワークフロー

Step 1: 対象範囲を特定する

ユーザーが何の要約を求めているかを確認します。

Option A: ナレッジベース全体

Tool: yuque_list_repos
Parameters:
  type: "user"

その後、ユーザーにリポジトリを選んでもらうか、指定されたものを使用します。

Option B: 複数のリポジトリにまたがる特定のトピック

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

Option C: ユーザーが対象のドキュメントを指定している そのまま読み取りに進みます。

Step 2: ドキュメント一覧を取得する

ナレッジベースを要約する場合は、目次を取得します。

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

これにより、タイトル、階層、ドキュメントのスラッグを含む全体構造を確認できます。

Step 3: ドキュメントを選び、読み取る

大規模なナレッジベース（20件超）の場合は、サンプリング戦略を使用します。

1. ドキュメントが10件以下の場合はすべて読む
2. 10件を超える場合は戦略的にサンプリングする
   • 最初に最上位のドキュメントや導入ドキュメントを読む
   • 主要なセクションごとに2〜3件のドキュメントを選ぶ
   • 最近更新されたドキュメントを優先する
   • 読むドキュメントは合計10〜15件までにする

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

Step 4: 分析して分類する

読み進めながら、以下を記録します。

• 主なテーマ — どのようなトピックが扱われているか
• コンテンツの種類 — チュートリアル、リファレンス、メモ、仕様書など
• 網羅性 — 十分に文書化されている領域と、情報が少ない領域
• 鮮度 — コンテンツがいつ更新されたか
• 関連性 — ドキュメント同士がどのように関連しているか

Step 5: 要約を作成する

以下の形式で要約を作成します。

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

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

---

### 🗂️ 内容结构

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

1. **[板块名称]**（X 篇文档）
   - [简要描述这个板块的内容]
   - 代表文档：[文档标题](链接)

2. **[板块名称]**（X 篇文档）
   - [简要描述]
   - 代表文档：[文档标题](链接)

3. **[板块名称]**（X 篇文档）
   - [简要描述]
   - 代表文档：[文档标题](链接)

---

### 🔑 核心要点

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

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

---

### 📊 知识库健康度

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

---

### 💡 建议

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

Step 6: 複数ドキュメントの要約（別の方法）

リポジトリ全体ではなく、特定のドキュメントを要約する場合：

## 📄 文档摘要

### 文档列表
| # | 标题 | 知识库 | 更新时间 |
|---|------|--------|----------|
| 1 | [标题](链接) | 「库名」 | YYYY-MM-DD |
| 2 | [标题](链接) | 「库名」 | YYYY-MM-DD |

### 综合摘要

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

### 各文档要点

#### 1. [文档标题]
- [要点 1]
- [要点 2]
- [要点 3]

#### 2. [文档标题]
- [要点 1]
- [要点 2]
- [要点 3]

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

ガイドライン

• 常にユーザーが使用した言語（中国語または英語）で回答する
• 大規模なナレッジベースの場合は、サンプリングしたことを明確に伝える。「知识库共有 X 篇文档，我抽样阅读了 Y 篇进行分析」
• ドキュメントのタイトルを列挙するだけでなく、実用的な洞察に焦点を当てる
• 不足している点や活用の機会を示す。何が欠けているかは、何があるかと同じくらい重要
• ユーザーが各トピックを詳しく確認できるよう、ドキュメントへのリンクを含める
• このスキルは個人のリポジトリを要約します。チームのリポジトリには、yuque-group プラグイン内の対応するスキルを使用してください

エラー処理

状況	対応
yuque_list_repos が空の結果を返す	正確なリポジトリ名または ID をユーザーに尋ねる
yuque_get_repo_toc が空の結果を返す	ナレッジベースが空のようだとユーザーに伝える
yuque_get_doc が失敗する（404）	このドキュメントをスキップし、削除された可能性があることを伝える
yuque_get_doc が失敗する（403）	このドキュメントへのアクセス権がない可能性があることをユーザーに伝える
API がタイムアウトする	1回再試行し、その後、接続の問題をユーザーに伝える
ナレッジベースに50件を超えるドキュメントがある	10〜15件をサンプリングし、サンプリング方法を明確に伝える