MCP 服务器

FalkorDB MCP Server

允许人工智能模型通过模型上下文协议（MCP）规范查询和与 FalkorDB 图数据库进行交互。

README

FalkorDB MCP 服务器

一个用于 FalkorDB 的模型上下文协议 (MCP) 服务器，允许 AI 模型查询和与图数据库交互。

概述

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

前提条件

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: 环境 (development, production)
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"
    }
  }
}