Falkordb MCPServer

🚀 FalkorDB MCP 服务器

FalkorDB MCP 服务器是一个为 FalkorDB 实现的模型上下文协议（MCP）服务器，它能让 AI 模型与图数据库进行查询和交互，为 AI 与数据库的连接提供了便捷的途径。

🚀 快速开始

该项目实现了一个遵循 Model Context Protocol (MCP) 规范的服务器，用于连接 AI 模型与 FalkorDB 图数据库。此服务器可将 MCP 请求转换为 FalkorDB 的请求，并依据 MCP 标准格式化响应。

✨ 主要特性

• 遵循 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 文件。