Henryhaoson Yuque MCP Server

🚀 语雀 Model-Context-Protocol (MCP) サーバー

本プロジェクトは、語雀の知識ベースとやり取りするための MCP サーバーの実装です。AI モデルが Model-Context-Protocol プロトコルを通じてサーバーに接続し、登録されたツールを利用して語雀プラットフォームのデータと機能を操作できるようにします。

MCP プロトコルは、AI モデルと外部ツールまたはサービス間のインターフェースを定義する標準化されたプロトコルです。このプロジェクトを通じて、AI モデルは文書の照会、作成、更新、削除やチームの統計情報の取得など、様々な操作を実行できます。

🚀 クイックスタート

このセクションでは、語雀 Model-Context-Protocol (MCP) サーバーの基本的な使い方を説明します。

✨ 主な機能

• AI モデルが Model-Context-Protocol プロトコルを通じてサーバーに接続できます。
• 登録されたツールを利用して語雀プラットフォームのデータと機能を操作できます。
• 文書の照会、作成、更新、削除やチームの統計情報の取得など、様々な操作が可能です。

📦 インストール

依存関係

以下の依存関係がインストールされていることを確認してください。

• Node.js (バージョン要件：18.0.0 以上)
• npm (バージョン要件：8.0.0 以上)

リポジトリのクローン

以下のコマンドを使用して、このプロジェクトをローカル開発環境にクローンします。

git clone https://github.com/yourusername/yuque-mcp-server.git

依存関係のインストール

プロジェクトディレクトリに移動した後、以下のコマンドを実行してすべての依存関係をインストールします。

npm install

📚 ドキュメント

設定

環境変数

config.example.ts ファイルをプロジェクトのルートディレクトリにコピーし、config.ts という名前に変更します。必要に応じて設定パラメータを変更します。

// config.ts
export const config = {
  port: 3000, // サーバーのポート
  baseUrl: 'https://api.yuque.com', // 語雀 API のベース URL
  accessToken: 'your_api_token_here' // 語雀 API のアクセストークン
};

その他の設定

必要に応じて、src/server.ts でサーバーの動作をさらに調整できます。

起動

MCP サーバーを起動します。

npm run dev

または、本番環境では以下のコマンドを使用します。

npm start

使用方法

SSE エンドポイントへの接続

以下の URL を使用して、サーバーの SSE (Server-Sent Events) エンドポイントに接続できます。

const eventSource = new EventSource(`http://localhost:${config.port}/sse`);

クエリパラメータの上書き

SSE エンドポイントに接続する際、クエリパラメータを使用して環境変数の設定を上書きできます。

// サンプル URL：
// http://localhost:3000/sse?accessToken=your_token_here&baseUrl=https://custom.yuque.api/v2

AI モデルとの統合

1. MCP サーバーを起動します。
2. 互換性のあるクライアントを使用してサーバーに接続します。
3. AI モデルは、登録されたツールを使用して語雀の知識ベースとやり取りできるようになります。

開発

プロジェクト構造

src/
├── config.ts          # サーバーの設定
├── index.ts           # メインエントリーポイント
├── cli.ts             # CLI エントリーポイント 
├── server.ts          # MCP サーバーの実装
└── services/
    └── yuque.ts       # 語雀 API サービス

新しいツールの追加

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

最近の更新

新機能

1. チーム統計データ：チーム、メンバー、知識ベース、文書の統計データを取得する機能を追加しました。
2. 文書管理の強化：
   • 複数の文書形式（Markdown、HTML、Lake）をサポートします。
   • 文書の公開設定（非公開、公開、企業内公開）を充実させました。
3. 検索機能の改善：より多くのパラメータとフィルタ条件をサポートします。

データ型の改善

インターフェース定義を更新し、語雀 OpenAPI 仕様と一致させました。

📄 ライセンス

ISC