Falkordb

🚀 FalkorDB MCP 服務器

FalkorDB MCP 服務器是一個專為 FalkorDB 打造的模型上下文協議（MCP）服務器，它能讓 AI 模型與圖數據庫進行查詢和交互，為 AI 與數據庫的連接提供了便捷的解決方案。

🚀 快速開始

該項目實現的服務器遵循模型上下文協議（MCP）規範，主要負責連接 AI 模型與 FalkorDB 圖數據庫。它會將 MCP 請求進行轉換並路由到 FalkorDB，同時依據 MCP 標準對響應進行格式化。

✨ 主要特性

• 遵循 MCP 規範，實現 AI 模型與 FalkorDB 圖數據庫的連接。
• 將 MCP 請求轉換並路由到 FalkorDB，並格式化響應。

📦 安裝指南

先決條件

• 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"
    }
  }
}

📄 許可證

此項目在 MIT 許可證下發布，詳細信息見 LICENSE 文件。

💪 貢獻

歡迎貢獻！請隨意提交 Pull Request。