JinDaGe - FalkorDB MCP Details

article

README

🚀 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 实例（可以在本地或远程运行）

安装步骤

克隆此仓库：

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

安装依赖项：

npm install

复制示例环境文件并进行配置：

cp .env.example .env

使用你的配置详细信息编辑 .env 文件。

📚 详细文档

配置

通过环境变量在 .env 文件中管理配置： | 属性 | 详情 | |------|------| | PORT | 服务器端口（默认：3000） | | NODE_ENV | 环境（开发、生产） | | FALKORDB_HOST | FalkorDB 主机（默认：localhost） | | FALKORDB_PORT | FalkorDB 端口（默认：6379） | | FALKORDB_USERNAME | FalkorDB 身份验证用户名（如果需要） | | FALKORDB_PASSWORD | FalkorDB 身份验证密码（如果需要） | | MCP_API_KEY | 用于身份验证 MCP 请求的 API 键 |

使用方法

开发

启动带有热重载功能的开发服务器：

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。

FalkorDB