Servidor MCP de FalkorDB

Un servidor de Protocolo de Contexto de Modelo (MCP) para FalkorDB, que permite que los modelos de IA consulten e interactúen con bases de datos de gráficos.

Descripción general

Este proyecto implementa un servidor que sigue la especificación del Protocolo de Contexto de Modelo (MCP) para conectar modelos de IA con bases de datos de grafos de FalkorDB. El servidor traduce y enruta las solicitudes MCP a FalkorDB y formatea las respuestas según el estándar MCP.

Related MCP server: W3 MCP FalkorDB Server

Prerrequisitos

• Node.js (v16 o posterior)

• npm o hilo

• Instancia de FalkorDB (se puede ejecutar local o remotamente)

Instalación

1. Clonar este repositorio:

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

2. Instalar dependencias:

   npm install

3. Copie el archivo de entorno de ejemplo y configúrelo:

   cp .env.example .env

   Edite .env con sus detalles de configuración.

Configuración

La configuración se gestiona a través de variables de entorno en el archivo .env :

• PORT : Puerto del servidor (predeterminado: 3000)

• NODE_ENV : Entorno (desarrollo, producción)

• FALKORDB_HOST : host de FalkorDB (predeterminado: localhost)

• FALKORDB_PORT : puerto de FalkorDB (predeterminado: 6379)

• FALKORDB_USERNAME : Nombre de usuario para la autenticación de FalkorDB (si es necesario)

• FALKORDB_PASSWORD : Contraseña para la autenticación de FalkorDB (si es necesario)

• MCP_API_KEY : Clave API para autenticar solicitudes MCP

Uso

Desarrollo

Inicie el servidor de desarrollo con recarga en caliente:

npm run dev

Producción

Construya e inicie el servidor:

npm run build
npm start

Puntos finales de API

• GET /api/mcp/metadata : Obtener metadatos sobre la instancia de FalkorDB y las capacidades disponibles

• POST /api/mcp/context : Ejecutar consultas en FalkorDB

• GET /api/mcp/health : Verificar el estado del servidor

• GET /api/mcp/graphs : Devuelve la lista de gráficos

Configuración de MCP

Para utilizar este servidor con clientes MCP, puede agregarlo a su configuración de MCP:

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

Para la configuración del lado del cliente:

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

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.