FalkorDB MCP Server

这是一个遵循模型上下文协议（MCP）规范的FalkorDB服务器，允许AI模型查询并与其图数据库进行交互。

概述

该项目实现了一个服务器，该服务器遵循模型上下文协议（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文件中的环境变量管理：

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