FalkorDB MCP 服务器

这是一个为 FalkorDB 设计的模型上下文协议（MCP）服务器，允许 AI 模型查询和与图数据库进行交互。

概述

本项目实现了一个遵循模型上下文协议 (MCP) 规范的服务器，用于连接 AI 模型与 FalkorDB 图数据库。该服务器将 MCP 请求翻译并路由到 FalkorDB，并根据 MCP 标准格式化响应。

前提条件

• Node.js (v16 或更高版本)
• npm 或 yarn
• FalkorDB 实例（可以本地运行或远程）

安装

1. 克隆此仓库：

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

2. 安装依赖项：

   bash npm install

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

   bash cp .env.example .env

   编辑 .env 文件以包含您的配置详情。

配置

通过 .env 文件中的环境变量管理配置：

• PORT: 服务器端口 (默认: 3000)
• NODE_ENV: 环境 (development, production)
• FALKORDB_HOST: FalkorDB 主机 (默认: localhost)
• FALKORDB_PORT: FalkorDB 端口 (默认: 6379)
• FALKORDB_USERNAME: FalkorDB 认证用户名 (如果需要)
• FALKORDB_PASSWORD: FalkorDB 认证密码 (如果需要)
• MCP_API_KEY: 用于认证 MCP 请求的 API 密钥

使用

开发

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

bash npm run dev

生产

构建并启动服务器：

bash 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 配置中：

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

客户端配置示例：

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

贡献

欢迎贡献！请随时提交 Pull Request。

许可

本项目采用 MIT 许可证 - 详情见 LICENSE 文件。