Falkordb MCPServer

🚀 FalkorDB MCP Server

A Model Context Protocol (MCP) server implemented for FalkorDB, enabling AI models to query and interact with the graph database.

🚀 Quick Start

This project implements a server that adheres to the Model Context Protocol (MCP) specification, designed to connect AI models with the FalkorDB graph database. The server translates MCP requests into FalkorDB requests and formats responses according to MCP standards.

✨ Features

• Connects AI models with FalkorDB graph database.
• Transforms MCP requests to FalkorDB requests and formats responses following MCP standards.

📦 Installation

Prerequisites

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

Steps

1. Clone this repository:

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

2. Install dependencies:

npm install

3. Copy the example environment file and configure it:

cp .env.example .env

Edit the .env file with your own configuration details.

📚 Documentation

Configuration

Manage configuration in the .env file through environment variables:

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 features.
• POST /api/mcp/context: Execute a query against FalkorDB.
• GET /api/mcp/health: Check the server's health status.
• GET /api/mcp/graphs: Return a list of graphs.

MCP Configuration

To use this server with an MCP client, 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 configuration:

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

🤝 Contribution

Contributions are welcome! Feel free to submit a Pull Request.

📄 License

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