Falkordb

by FalkorDB

239 downloads
Not rated
GitHub

Description

# 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…

About

# 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…

Details

Author
FalkorDB
Downloads
239
Categories
Other

- MCP‑compliant server for FalkorDB graph databases
- Translates MCP requests into FalkorDB queries
- Provides metadata, context execution, and health endpoints
- Configurable via environment variables
- Supports Docker deployment with a single command
- API‑key authentication for MCP requests

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Falkordb
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install Node.js v16+, clone the repository, install dependencies (npm install), copy .env.example to .env, set FALKORDB_HOST, FALKORDB_PORT, MCP_API_KEY, and optional credentials. Start development with npm run dev or build and run with npm start. Configure MCP clients by pointing to http://localhost:3000/api/mcp with the API key.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

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

1. Clone this repository:

   git clone https://github.com/yourusername/falkordb-mcp-server.git
   cd falkordb-mcp-server
   
2. Install dependencies:
   npm install
   
3. 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


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-mcp-server",
        "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 ISC License - see the LICENSE file for details.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.