Falkordb MCPServer

🚀 FalkorDB MCP サーバー

このサーバーは FalkorDB 用に実装された Model Context Protocol (MCP) サーバーで、AI モデルが FalkorDB グラフデータベースを照会し、それと対話できるようにします。

🚀 クイックスタート

このプロジェクトは、Model Context Protocol (MCP) 仕様に準拠したサーバーを実装しており、AI モデルと FalkorDB グラフデータベースを接続します。サーバーは MCP リクエストを FalkorDB のリクエストに変換し、MCP 標準に基づいてレスポンスをフォーマットします。

✨ 主な機能

• AI モデルと FalkorDB グラフデータベースを接続する。
• MCP リクエストを FalkorDB のリクエストに変換する。
• MCP 標準に基づいてレスポンスをフォーマットする。

📦 インストール

前提条件

• Node.js（v16 以上）
• npm または yarn
• FalkorDB インスタンス（ローカルまたはリモートで実行可能）

インストール手順

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

   git clone https://github.com/falkordb/falkordb-mcpserver.git
   cd falkordb-mcpserver
   

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

   npm install
   

3. サンプル環境ファイルをコピーし、設定します：

   cp .env.example .env
   

   .env ファイルを自分の設定詳細で編集します。

🔧 設定

.env ファイル内の環境変数を使用して設定を管理します：

💻 使用例

開発環境

ホットリロード機能付きの開発サーバーを起動します：

npm run dev

本番環境

サーバーをビルドして起動します：

npm run build
npm start

📚 ドキュメント

API エンドポイント

• GET /api/mcp/metadata：FalkorDB インスタンスと利用可能な機能のメタデータを取得します。
• POST /api/mcp/context：FalkorDB に対してクエリを実行します。
• GET /api/mcp/health：サーバーの健全性を確認します。
• GET /api/mcp/graphs：グラフのリストを返します。

MCP 設定

このサーバーを MCP クライアントとともに使用するには、MCP 設定に追加することができます：

{
  "mcpServers": {
    "falkordb": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-p", "3000:3000",
        "--env-file", ".env",
        "falkordb-mcpserver",
        "falkordb://host.docker.internal:6379"
      ]
    }
  }
}

クライアント設定の場合：

{
  "defaultServer": "falkordb",
  "servers": {
    "falkordb": {
      "url": "http://localhost:3000/api/mcp",
      "apiKey": "your_api_key_here"
    }
  }
}

🤝 貢献

貢献を歓迎します！自由に Pull Request を送信してください。

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細については LICENSE ファイルを参照してください。