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.

MCP Meilisearch API-сервер

Реализация сервера Model Context Protocol (MCP), которая обеспечивает мост между моделями ИИ и поисковой системой Meilisearch с использованием транспорта StreamableHTTP. Этот проект обеспечивает бесшовную интеграцию мощных поисковых возможностей Meilisearch в рабочие процессы ИИ.

Обновленный обзор

Этот проект предоставляет сервер MCP, который позволяет моделям ИИ напрямую взаимодействовать с функциональными возможностями Meilisearch. Архитектура включает:

  • Сервер MCP : предоставляет API Meilisearch в качестве инструментов, использующих протокол контекста модели.
  • Демонстрация веб-клиента : демонстрационный интерфейс, демонстрирующий функции поиска.

Основные характеристики

  • StreamableHTTP Transport : связь в реальном времени между клиентами и сервером.
  • Поддержка API Meilisearch : полный доступ к функциям Meilisearch.
  • Улучшенная обработка ошибок : улучшенное управление ошибками для запросов API.
  • Демонстрация веб-клиента : обновленный интерфейс для демонстрации возможностей поиска.

Категории инструментов

Сервер MCP организует API Meilisearch по следующим категориям:

  1. Системные инструменты : проверки работоспособности, информация о версии, статистика сервера.
  2. Инструменты индексирования : управление индексами (создание, обновление, удаление, составление списка).
  3. Инструменты для работы с документами : добавление, обновление, удаление и извлечение документов.
  4. Инструменты поиска : расширенный поиск, включая векторный поиск.
  5. Инструменты настроек : настройка параметров индекса.
  6. Инструменты задач : управление асинхронными задачами.
  7. Векторные инструменты : экспериментальные возможности поиска векторов.

Начиная

Предпосылки

  • Node.js v20 или выше.
  • Работающий экземпляр Meilisearch (локальный или удаленный).
  • API-ключ для Meilisearch (при необходимости).

Инструкции по установке

  1. Клонируйте репозиторий:
git clone <repository-url>
  1. Установить зависимости:
npm install
  1. Настройте среду:

Создайте файл .env со следующим содержимым:

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

Запуск сервера

Чтобы запустить сервер:

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

Доступ к веб-интерфейсу

Откройте следующий URL-адрес в своем браузере:

http://localhost:8080

Разработка

В этом проекте используются:

  • TypeScript : обеспечивает безопасность типов.
  • Express : обеспечивает работу веб-сервера.
  • SDK протокола контекста модели : облегчает интеграцию ИИ.

Параметры

Параметры подключения Meilisearch
  • meilisearchHost : URL-адрес экземпляра Meilisearch (по умолчанию: « http://localhost:7700 »)
  • meilisearchApiKey : API-ключ для аутентификации с помощью Meilisearch (по умолчанию: "")
Параметры сервера MCP
  • transport : Тип транспорта для сервера MCP ("http" | "stdio") (по умолчанию: "http")
  • httpPort : HTTP-порт для сервера MCP (по умолчанию: 8080)
  • mcpEndpoint : путь к конечной точке MCP (по умолчанию: "/mcp")
Параметры сеанса
  • sessionTimeout : время ожидания сеанса в миллисекундах (по умолчанию: 3600000)
  • sessionCleanupInterval : интервал очистки сеанса в миллисекундах (по умолчанию: 60000)

Использование MCPClient

Пакет также экспортирует класс MCPClient для интеграции на стороне клиента:

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