Feishu Doc MCP

🚀 Feishu Doc MCP

これは、飛書オープンプラットフォームのドキュメントにアクセスするための Model Context Protocol (MCP) サーバーです。このサーバーにより、Claude などの AI アシスタントが直接飛書 API ドキュメントを検索および閲覧できます。

✨ 主な機能

ゼロコンフィグ、API Key 不要

飛書公式の公開ドキュメントインターフェースに直接接続し、Token や API Key を申請する必要がなく、すぐに使えます。

動的同期、常に最新

分類リストは飛書 API からリアルタイムで取得され、公式ドキュメントの構造変更に自動的に適応し、ハードコードのメンテナンス負担がありません。飛書が新しい API 分類を追加または調整した場合、このツールは自動的に同期します。

完全網羅、4800+ のドキュメント

飛書オープンプラットフォームのすべてのドキュメント体系をサポートし、サーバーサイド API、クライアント API、開発ガイド、開発チュートリアルなど 100 以上の分類を含み、インスタントメッセージ、カレンダー、アドレス帳、クラウドドキュメント、承認、人事などのすべての機能を網羅しています。

コンテンツのスマート処理

• 大きなファイルは自動的に分割読み取りを促し、context window を保護します。
• 一時ファイルはスマートに命名され（読みやすい接頭辞 + Hash）、衝突を回避します。

高性能設計

• 起動時にドキュメントインデックスと URI マッピングを並列で読み込みます。
• 4800 以上のドキュメントマッピングをメモリキャッシュし、O(1) の時間計算量でクエリを実行します。
• 長時間の運用をサポートし、繰り返し初期化する必要がありません。

📦 インストール

npx を使用する（推奨）

インストールする必要はなく、npx を直接使用して実行します。

npx feishu-doc-mcp@latest

@latest を使用すると、毎回最新バージョンを取得できます。

グローバルインストール

npm install -g feishu-doc-mcp

次に、以下のコマンドを実行します。

feishu-doc-mcp

💻 使用例

Claude Desktop での使用

以下の設定を Claude Desktop の設定ファイルに追加します。

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "feishu-doc": {
      "command": "npx",
      "args": ["feishu-doc-mcp@latest"]
    }
  }
}

グローバルインストールした場合は、以下の設定を使用します。

{
  "mcpServers": {
    "feishu-doc": {
      "command": "feishu-doc-mcp"
    }
  }
}

利用可能なツール

search_feishu_doc

分類で飛書 API ドキュメントを検索し、その分類に属するドキュメントのリストを返します。

パラメータ:

• category: ドキュメントの分類。「一次ディレクトリ_二次ディレクトリ」の形式（例: 「サーバーサイド API_インスタントメッセージ」、「開発ガイド_ロボット開発」）

read_feishu_doc

飛書 API ドキュメントの詳細内容を読み取ります。内容は一時ファイルに保存され、アクセスしやすくなります。

パラメータ:

• path: ドキュメントのパス（search_feishu_doc の結果から取得）

📚 ドキュメント

開発

# 依存関係のインストール
npm install

# ビルド
npm run build

# 開発モードで実行
npm run dev

# サーバーの起動
npm start

リリース

このプロジェクトは GitHub Actions を使用して自動的に npm にリリースされます。新しいバージョンをリリースするには、以下の手順に従います。

1. package.json のバージョン番号を更新します。
2. 変更をコミットします。
3. タグを作成してプッシュします。

   git tag v1.0.1
   git push origin v1.0.1
   

4. GitHub Actions が自動的にビルドして npm にリリースします。

環境要件

• Node.js >= 18

更新履歴

v1.0.7

• feat: 大きなドキュメントをサブタイトルで分割し、分割読み取りを容易にします。
• feat: リクエストのサンプルファイルをドキュメントディレクトリに保存し、ファイルの整理を改善します。

v1.0.6

• feat: Markdown コンテンツから md-* タグと余分な空行を削除します。
• feat: 各言語の SDK リクエストサンプルを抽出し、個別に保存します。

v1.0.5

• refactor: turndown 依存関係を削除し、コードを簡素化します。

📄 ライセンス

MIT

作者

ztxtxwd