Configuration

Environment Variables

# FalkorDB Configuration
FALKORDB_HOST=localhost
FALKORDB_PORT=6379
FALKORDB_USERNAME=          # Optional
FALKORDB_PASSWORD=          # Optional
FALKORDB_DEFAULT_READONLY=false  # Set to 'true' for read-only mode

# Transport Mode
MCP_TRANSPORT=stdio         # 'stdio' (default) or 'http'
MCP_PORT=3000              # Port for HTTP transport
MCP_API_KEY=               # Optional API key for HTTP transport

# Logging (optional)
ENABLE_FILE_LOGGING=false

Transport Modes

stdio (default)

Used for direct integration with AI clients like Claude Desktop. Communication happens via standard input/output.

MCP_TRANSPORT=stdio

HTTP

Exposes the MCP server over HTTP for remote or networked access:

MCP_TRANSPORT=http
MCP_PORT=3000
MCP_API_KEY=your-secret-api-key  # Optional but recommended

When using HTTP transport, clients connect via the MCP Streamable HTTP protocol. API key authentication is enforced via the Authorization: Bearer <key> header when MCP_API_KEY is set.

Read-Only Mode for Replica Instances

Enable read-only mode by default to prevent writes to replica instances:

FALKORDB_DEFAULT_READONLY=true

Use cases:

  • Replica instances: Prevent writes to read replicas in replication setups
  • Production safety: Ensure critical data isn’t accidentally modified
  • Reporting/analytics: Run queries for dashboards without risk of data changes
  • Multi-tenant environments: Provide read-only access to certain users

Running Multiple Instances

You can configure multiple MCP servers for different FalkorDB instances:

{
  "mcpServers": {
    "falkordb-dev": {
      "command": "npx",
      "args": ["-y", "@falkordb/mcpserver@latest"],
      "env": {
        "FALKORDB_HOST": "dev.falkordb.local",
        "FALKORDB_DEFAULT_READONLY": "false"
      }
    },
    "falkordb-prod-replica": {
      "command": "npx",
      "args": ["-y", "@falkordb/mcpserver@latest"],
      "env": {
        "FALKORDB_HOST": "replica.falkordb.com",
        "FALKORDB_DEFAULT_READONLY": "true"
      }
    }
  }
}