mcpField
G
GitHub Actions 工作流使用说明

GitHub Actions 工作流使用说明

ローカル
github.com/HenryHaosonバージョン管理6952 週間前に更新
リポジトリ

GitHub Actions 工作流使用说明 について

语雀 MCP サーバーは、語雀オープン API と連携する MCP サーバーです。AI モデルから語雀のドキュメントを作成、読み取り、更新、削除し、ナレッジベースやチームの統計情報を取得できます。HTTP と CLI stdio の両モードで動作し、Docker でのデプロイにも対応しています。

主な機能

  1. 01ドキュメントの作成、読み取り、更新、削除
  2. 02ユーザー、ナレッジベース、ドキュメントの一覧取得
  3. 03範囲と作成者で絞り込む検索
  4. 04チームメンバー、ナレッジベース、ドキュメントの統計

活用シーン

  1. 01AI モデルから語雀のドキュメントを読み書きする
  2. 02チームのナレッジベースの閲覧と編集状況を集計する
#mcp#yuque#yuque-mcp

設定

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

mcp.json · 共通設定
{
  "mcpServers": {
    "Yuque-MCP-Server": {
      "command": "npx",
      "args": [
        "-y",
        "@smithery/cli"
      ]
    }
  }
}
起動コマンドnpx -y @smithery/cli

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

パッケージ
npm@smithery/cli

ツール

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

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

詳細

语雀 MCP サーバー

smithery badge

英語版

语雀 API と連携する Model-Context-Protocol（MCP）サーバーです。この実装は Figma-Context-MCP に着想を得ており、语雀 オープン API を使用しています。

概要

このサーバーは、语雀のナレッジベースプラットフォームと連携する MCP ツールを提供し、AI モデルが次の操作を行えるようにします。

  • ユーザーやドキュメントの情報を取得する
  • ドキュメントを作成、読み取り、更新、削除する
  • 语雀内のコンテンツを検索する
  • ナレッジベースの情報を取得する
  • 統計データや分析情報を取得する

インストール

Smithery 経由でインストールする

Smithery を使用して、Yuque MCP Server を Claude デスクトップ版に自動インストールするには、次の手順を実行します。

npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude
前提条件
  • Node.js 18 以上（推奨）
  • API トークンを持つ语雀アカウント
セットアップ

  1. このリポジトリをクローンします。

    git clone https://github.com/Henryhaoson/Yueque-MCP-Server.git
cd Yueque-MCP-Server

  2. 依存関係をインストールします。

    npm install

  3. .env.example をもとに .env ファイルを作成します。

    cp .env.example .env

  4. （任意）.env ファイルに语雀 API トークンを追加します。

    YUQUE_API_TOKEN=your_yuque_api_token_here

    .env ファイルに設定する代わりに、サーバーへの接続時にクエリパラメーターでトークンを指定することもできます。

使用方法

サーバーを実行する
開発モード
# HTTP 服务器模式
npm run dev

# CLI stdio 模式
npm run dev:cli
本番モード

まず、プロジェクトをビルドします。

npm run build

次に、HTTP モードまたは CLI モードで実行します。

# HTTP 服务器模式
npm run start

# CLI stdio 模式
npm run start:cli
Docker を使用したデプロイ

このプロジェクトは Docker に対応しているため、サーバーを簡単にコンテナ化してデプロイできます。

Docker Compose を使用する（推奨）

  1. コンテナをビルドして起動します。

    docker-compose up -d

  2. ログを確認します。

    docker-compose logs -f

  3. サービスを停止します。

    docker-compose down

環境変数または .env ファイルで設定項目を指定できます。

# .env 文件示例
PORT=3000
YUQUE_API_TOKEN=your_token_here
YUQUE_API_BASE_URL=https://www.yuque.com/api/v2
Docker を手動で使用する

  1. Docker イメージをビルドします。

    docker build -t yuque-mcp-server .

  2. コンテナを実行します。

    docker run -d -p 3000:3000 --name yuque-mcp-server yuque-mcp-server

  3. 環境変数を使用します。

    docker run -d -p 3000:3000 \
  -e YUQUE_API_TOKEN=your_token_here \
  -e YUQUE_API_BASE_URL=https://www.yuque.com/api/v2 \
  --name yuque-mcp-server yuque-mcp-server
MCP ツール

语雀 MCP サーバーは、次のツールを提供します。

ユーザーとドキュメントの管理
  • get_current_user - 現在認証されているユーザーの情報（ユーザー ID、ユーザー名、アバターなどの语雀アカウントの基本情報を含む）を取得します
  • get_user_docs - 現在のユーザーのすべてのナレッジベースドキュメント一覧を取得します。個人用ドキュメントと共同作業用ドキュメントが含まれます
  • get_user_repos - 指定したユーザーのナレッジベース一覧を取得します。ナレッジベースは、语雀でドキュメントを整理するためのコレクションです
  • get_repo_docs - 特定のナレッジベースにあるすべてのドキュメント一覧（ドキュメントのタイトルや更新日時などの情報を含む）を取得します
  • get_doc - 语雀内の特定のドキュメントの詳細（本文、変更履歴、権限情報を含む）を取得します
  • create_doc - 指定したナレッジベースに新しい语雀ドキュメントを作成します。複数の形式（Markdown、HTML、Lake）のコンテンツに対応しています
  • update_doc - 语雀に既存のドキュメントを更新します。タイトル、コンテンツ、権限設定を変更できます
  • delete_doc - 语雀のナレッジベースから指定したドキュメントを削除します。この操作は取り消せません
  • search - 语雀プラットフォーム内のドキュメントやナレッジベースのコンテンツを検索します。範囲や作成者による絞り込みに対応しています
チームの統計分析
  • get_group_statistics - メンバー数、ドキュメント数、閲覧数、インタラクションデータなど、チームの集計統計データを取得します
  • get_group_member_statistics - 各メンバーの編集回数、閲覧数、いいね数など、チームメンバーの統計データを取得します
  • get_group_book_statistics - 各ナレッジベースのドキュメント数、文字数、閲覧数など、チームのナレッジベース統計データを取得します
  • get_group_doc_statistics - 各ドキュメントの文字数、閲覧数、コメント数など、チームのドキュメント統計データを取得します

AI モデルとの統合

この MCP サーバーは、Model-Context-Protocol に対応した AI モデルとともに使用でき、定義されたツールを介して语雀と連携できます。たとえば、次の手順で使用します。

  1. MCP サーバーを起動します
  2. 互換性のあるクライアントからサーバーに接続します
  3. AI モデルが登録済みのツールを使って语雀のデータと連携できるようになります
SSE エンドポイントのクエリパラメーター

SSE エンドポイントへの接続時には、クエリパラメーターを使って環境設定を上書きできます。これらのパラメーターは環境変数より優先されます。

  • accessToken：.env ファイルに設定された语雀 API トークンを上書きします
  • baseUrl：.env ファイルに設定された语雀 API のベース URL を上書きします

例：

http://localhost:3000/sse?accessToken=your_token_here&baseUrl=https://custom.yuque.api/v2

これにより、.env ファイルを変更せずにサービスを動的に設定できます。また、クエリパラメーターは環境変数より優先されます。これは、マルチユーザー環境や異なる API エンドポイントのテストに特に便利です。

SSE 接続ごとに異なる設定を使用できるため、同じサーバーインスタンスを複数のユーザーや環境に同時に提供できます。

開発

プロジェクト構成
src/
  ├── config.ts          # 服务器配置
  ├── index.ts           # 主入口点
  ├── cli.ts             # CLI 入口点 
  ├── server.ts          # MCP 服务器实现
  └── services/
      └── yuque.ts       # 语雀 API 服务
新しいツールの追加

新しいツールを追加するには、src/server.ts の registerTools メソッドを変更します。

API の改善

最近の更新で、次の機能が追加されました。

  1. チーム統計データ：チーム、メンバー、ナレッジベース、ドキュメントの統計データを取得する機能を追加しました。チームのナレッジベースの利用状況を分析・監視しやすくなります。

  2. ドキュメント管理の強化：

    • 複数のドキュメント形式（Markdown、HTML、Lake）に対応
    • ドキュメントの公開範囲設定を拡充（非公開、公開、企業内公開）
    • 検索機能がより多くのパラメーターと絞り込み条件に対応

  3. データ型の整備：インターフェース定義を更新し、语雀 OpenAPI 仕様に準拠させました。

ライセンス

MIT License

Copyright (c) 2025 Henryhaoson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

致谢

コメント

Markdown 対応

MCP は初めてですか？

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

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