mcp-meilisearch

by falcosan

Integrations

  • Integrates with dotenv for environment variable management, specifically for Meilisearch connection configuration including host, API key, and timeout settings.

  • Uses Express for the web server component that hosts the MCP server implementation, enabling the StreamableHTTP transport for communication between clients and the Meilisearch API.

  • Employs Lerna for workspace management across the MCP server components that provide Meilisearch integration.

Servidor API de MCP Meilisearch

Una implementación de servidor del Protocolo de Contexto de Modelo (MCP) que conecta los modelos de IA con el motor de búsqueda Meilisearch mediante el transporte StreamableHTTP. Este proyecto permite una integración fluida de las potentes funciones de búsqueda de Meilisearch en los flujos de trabajo de IA.

Descripción general actualizada

Este proyecto proporciona un servidor MCP que permite que los modelos de IA interactúen directamente con las funcionalidades de Meilisearch. La arquitectura incluye:

  • Servidor MCP : expone las API de Meilisearch como herramientas utilizando el Protocolo de contexto de modelo.
  • Demostración de cliente web : una interfaz de demostración que muestra las funcionalidades de búsqueda.

Características principales

  • Transporte StreamableHTTP : Comunicación en tiempo real entre los clientes y el servidor.
  • Soporte de API de Meilisearch : acceso completo a las funcionalidades de Meilisearch.
  • Manejo de errores mejorado : gestión de errores mejorada para solicitudes de API.
  • Demostración del cliente web : Interfaz actualizada para demostrar las capacidades de búsqueda.

Categorías de herramientas

El servidor MCP organiza las API de Meilisearch en estas categorías:

  1. Herramientas del sistema : comprobaciones de estado, información de versión, estadísticas del servidor.
  2. Herramientas de índice : Administrar índices (crear, actualizar, eliminar, listar).
  3. Herramientas de documentos : agregue, actualice, elimine y recupere documentos.
  4. Herramientas de búsqueda : Búsqueda avanzada, incluida búsqueda vectorial.
  5. Herramientas de configuración : configure los ajustes del índice.
  6. Herramientas de tareas : Administrar tareas asincrónicas.
  7. Herramientas vectoriales : capacidades de búsqueda vectorial experimental.

Empezando

Prerrequisitos

  • Node.js v20 o superior.
  • Una instancia de Meilisearch en ejecución (local o remota).
  • Clave API para Meilisearch (si es necesario).

Instrucciones de configuración

  1. Clonar el repositorio:
git clone <repository-url>
  1. Instalar dependencias:
npm install
  1. Configurar el entorno:

Crea un archivo .env con el siguiente contenido:

MEILISEARCH_HOST=http://localhost:7700 MEILISEARCH_API_KEY=your_master_key_here

Ejecución del servidor

Para iniciar el servidor:

npm run server # Start the MCP server npm run demo # Start the Web client demo

Acceder a la interfaz web

Visita la siguiente URL en tu navegador:

http://localhost:8080

Desarrollo

Este proyecto utiliza:

  • TypeScript : garantiza la seguridad de tipos.
  • Express : alimenta el servidor web.
  • SDK de protocolo de contexto de modelo : facilita la integración de IA.

Opciones

Opciones de conexión de Meilisearch
  • meilisearchHost : URL de la instancia de Meilisearch (predeterminado: " http://localhost:7700 ")
  • meilisearchApiKey : clave API para autenticarse con Meilisearch (predeterminado: "")
Opciones del servidor MCP
  • transport : Tipo de transporte para el servidor MCP ("http" | "stdio") (predeterminado: "http")
  • httpPort : puerto HTTP para el servidor MCP (predeterminado: 8080)
  • mcpEndpoint : ruta del punto final de MCP (predeterminado: "/mcp")
Opciones de sesión
  • sessionTimeout : Tiempo de espera de la sesión en milisegundos (predeterminado: 3600000)
  • sessionCleanupInterval : intervalo de limpieza de sesión en milisegundos (predeterminado: 60000)

Uso de MCPClient

El paquete también exporta la clase MCPClient para la integración del lado del cliente:

import { MCPClient } from "mcp-meilisearch/client"; const client = new MCPClient("mcp-meilisearch-client"); await client.connectToServer("http://localhost:3000/mcp"); // Call a tool const result = await client.callTool("search-across-all-indexes", { q: "search kiosco antonio", });

Related MCP Servers

View all related MCP servers

ID: 6p320dzr8s