FalkorDB MCP Server

Use This MCP server To

Query FalkorDB graph databases using natural language via AI models Enable AI-driven graph data exploration and analysis Integrate graph database context into AI workflows Translate AI model requests into graph database queries Provide structured graph data responses to LLMs Support real-time interaction between AI and graph data Facilitate multi-step reasoning over graph data with LLMs

README

FalkorDB MCP Server

A Model Context Protocol (MCP) server for FalkorDB, allowing AI models to query and interact with graph databases.

Overview

This project implements a server that follows the Model Context Protocol (MCP) specification to connect AI models with FalkorDB graph databases. The server translates and routes MCP requests to FalkorDB and formats the responses according to the MCP standard.

Prerequisites

Node.js (v16 or later)
npm or yarn
FalkorDB instance (can be run locally or remotely)

Installation

Clone this repository:

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

Install dependencies:
```
npm install
```
Copy the example environment file and configure it:
```
cp .env.example .env
```
Edit .env with your configuration details.

Configuration

Configuration is managed through environment variables in the .env file:

PORT: Server port (default: 3000)
NODE_ENV: Environment (development, production)
FALKORDB_HOST: FalkorDB host (default: localhost)
FALKORDB_PORT: FalkorDB port (default: 6379)
FALKORDB_USERNAME: Username for FalkorDB authentication (if required)
FALKORDB_PASSWORD: Password for FalkorDB authentication (if required)
MCP_API_KEY: API key for authenticating MCP requests

Usage

Development

Start the development server with hot-reloading:

npm run dev

Production

Build and start the server:

npm run build
npm start

API Endpoints

GET /api/mcp/metadata: Get metadata about the FalkorDB instance and available capabilities
POST /api/mcp/context: Execute queries against FalkorDB
GET /api/mcp/health: Check server health
GET /api/mcp/graphs: Returns the list of Graphs

MCP Configuration

To use this server with MCP clients, you can add it to your MCP configuration:

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

For client-side configuration:

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

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

FalkorDB-MCPServer FAQ

How do I install FalkorDB MCP Server?

Clone the repository, install dependencies with npm or yarn, and configure the .env file with your FalkorDB details.

What are the prerequisites for running FalkorDB MCP Server?

You need Node.js v16 or later, npm or yarn, and a running FalkorDB instance (local or remote).

How does FalkorDB MCP Server handle MCP requests?

It translates MCP requests into FalkorDB graph queries and formats the responses according to the MCP specification.

Can FalkorDB MCP Server be configured for different environments?

Yes, configuration is managed through environment variables in the .env file, including server port and FalkorDB connection details.

Is FalkorDB MCP Server compatible with multiple LLM providers?

Yes, it supports any LLM that uses the MCP standard, including OpenAI, Anthropic Claude, and Google Gemini.

What programming environment is required to run FalkorDB MCP Server?

It runs on Node.js (v16 or later) and requires npm or yarn for dependency management.

Can FalkorDB MCP Server be used for real-time graph data interaction?

Yes, it enables real-time, structured interaction between AI models and FalkorDB graph databases.