FalkorDB MCP Server

Integrations

  • Provides configuration management for the MCP server through environment variables stored in a .env file.

  • Allows running the FalkorDB MCP server in a containerized environment with network configuration for connecting to FalkorDB instances.

  • Supports repository cloning as part of the installation process for the FalkorDB MCP server.

FalkorDB MCP 服务器

FalkorDB 的模型上下文协议 (MCP) 服务器,允许 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" } } }

贡献

欢迎贡献代码!欢迎提交 Pull 请求。

执照

该项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅LICENSE文件。

-
security - not tested
A
license - permissive license
-
quality - not tested

允许 AI 模型通过模型上下文协议 (MCP) 规范查询和与 FalkorDB 图形数据库交互。

  1. Overview
    1. Prerequisites
      1. Installation
        1. Configuration
          1. Usage
            1. Development
            2. Production
          2. API Endpoints
            1. MCP Configuration
              1. Contributing
                1. License
                  ID: 0r7jit736n