mcpField
Y
yuque-mcp

yuque-mcp

ローカル
github.com/yuqueメモリ・ナレッジ25915 週間前に更新

yuque-mcp について

yuque-mcp は語雀(Yuque)向けの MCP サーバーで、AI アシスタントがユーザーのナレッジベースを読み書きできるようにします。語雀で文書を管理する個人やチーム向けで、個人トークンとスペース単位のチームトークンに対応しています。

主な機能

  1. 01ドキュメントとリポジトリの検索
  2. 02ナレッジベース、ドキュメント、目次の管理
  3. 03ノート(小記)の読み取りと書き込み
  4. 04フローチャートなどのボードの読み取りと更新
  5. 05複数のクライアントへ一括で設定を追加

活用シーン

  1. 01語雀の内容の検索と要約作成
  2. 02会議メモのナレッジベース文書への変換
  3. 03設計ドキュメントへのフローチャート追加

MCP 対応

本プロジェクトは MCP サーバーであり、ユーザー、ナレッジベース、ドキュメント、目次、ノート、ボードの読み書きに関する 19 個の語雀 API ツールを MCP クライアントに公開します。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
"mcpServers": {
"yuque-yuque": {
"command": "npx",
"args": [
"-y",
"yuque-mcp"
],
"env": {
"YUQUE_PERSONAL_TOKEN": "<YUQUE_PERSONAL_TOKEN>",
"YUQUE_GROUP_TOKEN": "<YUQUE_GROUP_TOKEN>",
"YUQUE_TOKEN": "<YUQUE_TOKEN>"
}
}
}
}
起動コマンドnpx -y yuque-mcp
設定が必要な環境変数
YUQUE_PERSONAL_TOKENシークレットYuque personal API token (get from https://www.yuque.com/settings/tokens). Use one of: YUQUE_PERSONAL_TOKEN, YUQUE_GROUP_TOKEN, or YUQUE_TOKEN.
YUQUE_GROUP_TOKENシークレットYuque group/team API token (alternative to YUQUE_PERSONAL_TOKEN for team workspaces).
YUQUE_TOKENシークレットYuque API token (legacy, use YUQUE_PERSONAL_TOKEN or YUQUE_GROUP_TOKEN instead).

ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
npmyuque-mcp0.1.4

ツール

ツール一覧はまだ取得されていません

ローカルサーバーのツールはマシン上で起動して初めて取得できます。メンテナーはまだツール一覧を提供していません。

詳細

Yuque のロゴ

Yuque MCP Server

AI アシスタントが Model Context Protocol を通じて
ナレッジベース Yuque (语雀) を読み書きできるようにします。

CI npm version npm downloads License

クイックスタート · ツール · トラブルシューティング · ドキュメント · 中国語ドキュメント

接続後は、アシスタントに次のようなことを頼めます。

「Yuque でカナリアリリースに関する内容をすべて検索して、1 ページにまとめてください。」

「今日の会議メモを、Tech Research の本にドキュメントとして追加してください。」

「このデプロイパイプラインのフローチャートを設計ドキュメントに追加してください。」

クイックスタート

1. トークンを取得する — Yuque Developer Settings で作成します。Yuque スペースに紐づいたチームトークンを使用する場合は、スペースのホスト(例:https://your-space.yuque.com)も控えてください。これは --host として指定します。

2. インストールする — 1 つのコマンドで、OS に応じた設定ファイルを見つけ、他のサーバーに触れることなく yuque エントリを追加します。

npx yuque-mcp install --token=YOUR_TOKEN --client=cursor

対応クライアント:claude-desktop · vscode · cursor · windsurf · cline · trae · qoder · opencode。対話形式で設定する場合は、npx yuque-mcp setup を実行してください。

Claude Code

サーバーを直接登録します。

claude mcp add yuque -- npx -y yuque-mcp --token=YOUR_TOKEN
その他の MCP クライアント(汎用設定)

stdio トランスポートに対応するクライアントであれば使用できます。クライアントごとの設定ファイルのパスについては、docs/clients.md を参照してください。

{
  "mcpServers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": { "YUQUE_TOKEN": "YOUR_TOKEN" }
    }
  }
}

3. クライアントを再起動して、使い始めましょう。

設定

設定環境変数/CLI フラグ説明
Token (必須)YUQUE_TOKEN / --token個人またはチームの Yuque API トークン
Host(任意)YUQUE_HOST / --hostサイトまたはスペースのホスト。例:https://your-space.yuque.com — スペースに紐づいたチームトークンおよびプライベートデプロイでは必須です

サイトのルートは /api/v2 に正規化されます。未設定の場合、ホストは https://www.yuque.com/api/v2 がデフォルトになります。

# Team token / private deployment
npx yuque-mcp install --token=YOUR_TOKEN --client=cursor --host=https://your-space.yuque.com
以前の設定から移行しますか?

YUQUE_PERSONAL_TOKEN、YUQUE_BASE_URL、--base-url は、従来のフォールバックとして引き続き使用できます。優先順位は YUQUE_TOKEN > YUQUE_PERSONAL_TOKEN > --token、および YUQUE_HOST > --host > YUQUE_BASE_URL > --base-url です。新しい設定では YUQUE_TOKEN と YUQUE_HOST を使用してください。

## ツール(19)

各ツールは、Yuque API のルートにそれぞれ1つだけ対応しています。

カテゴリツール説明
ユーザーyuque_get_user現在のトークンで認証されたユーザーを取得します
検索yuque_searchページネーションを指定して、ドキュメントまたはリポジトリを検索します
ナレッジベースyuque_list_booksユーザーのナレッジベース(知识库)を一覧表示します
yuque_get_bookID または namespace でナレッジベースを取得します
yuque_create_bookナレッジベースを作成します
yuque_update_book名前、slug、説明、または公開範囲を更新します
ドキュメントyuque_list_docsページネーションを指定して、ナレッジベース内のドキュメントを一覧表示します
yuque_get_doc完全なコンテンツを取得します — markdown、lake、または html
yuque_create_docナレッジベース内にドキュメントを作成します
yuque_update_docドキュメントの本文またはメタデータを更新します
目次yuque_get_tocナレッジベースの目次を取得します
yuque_update_toc目次ノードを1つ追加または移動します
ノートyuque_list_notesページネーションとステータスフィルターを指定して、ノート(小记)を一覧表示します
yuque_get_note完全なコンテンツを含むノートを取得します
yuque_create_noteノートを作成します
yuque_update_noteノートを更新します
ボードyuque_get_resourceドキュメントからボード(マインドマップ/フローチャート/図)を読み取ります
yuque_create_resourceドキュメント内にボードを作成します
yuque_update_resourceドキュメント内のボードを更新します

特に、yuque_update_doc では、Markdown 本文と title/slug/public の変更を1回の呼び出しで組み合わせることはできません。メタデータは別途更新してください。YMD Markdown API と従来のドキュメント API 間のフォーマットルーティングを含む完全な仕様については、docs/capability-scope.md を参照してください。

未対応の機能: コメント、添付ファイルのアップロードとファイル管理、権限およびメンバーの管理、ドキュメントのセクション単位の編集、ボード以外の構造化リソース。

書き込みアクセス

作成/更新ツールはナレッジベースの実際のコンテンツを変更します。また、サーバーはトークンで許可されている操作をすべて実行できます。トークンは秘密に保管し、1つのスペース内でのみ作業する場合は、スペースにスコープを限定したチームトークン(YUQUE_HOST を指定)を使用してください。脆弱性を報告するには、SECURITY.md を参照してください。

トラブルシューティング

エラー解決方法
YUQUE_TOKEN ... is requiredYUQUE_TOKEN=YOUR_TOKEN を設定するか、--token=YOUR_TOKEN を渡してください
401 Unauthorizedトークンが無効または期限切れです — 再生成してください
429 Rate Limitedリクエストが多すぎます — 少し待ってから再試行してください
410 Gone対象は完全に削除されたか、エンドポイントが廃止されています — ドキュメント/ナレッジベースが存在するか確認してください
ツールが見つかりません最新バージョンに更新してください:npx -y yuque-mcp@latest
npx コマンドが見つかりませんNode.js v18 以降をインストールしてください

開発

git clone https://github.com/yuque/yuque-mcp-server.git
cd yuque-mcp-server
npm install
npm test              # run tests
npm run build         # compile TypeScript
npm run dev           # dev mode with hot reload

アーキテクチャ、技術スタック、ツールの完全な契約はdocs/に記載されています。貢献を歓迎します。CONTRIBUTING.mdをご覧ください。

リンク

ライセンス

MIT

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。