Meilisearch

• Consultar la configuración de conexión actual
• Cambiar dinámicamente entre instancias de Meilisearch
• Actualizar las claves API sobre la marcha

• Crear índices con claves primarias personalizadas
• Enumerar todos los índices con sus estadísticas
• Eliminar índices y sus datos
• Consultar métricas detalladas de los índices

• Añadir o actualizar documentos
• Recuperar documentos con paginación
• Importar datos en bloque

• Buscar con filtros, ordenación y facetas
• Buscar en varios índices
• Búsqueda semántica con vectores
• Búsqueda híbrida (por palabras clave + semántica)

• Configurar reglas de clasificación
• Configurar facetas y filtros
• Administrar atributos de búsqueda
• Personalizar la tolerancia a errores tipográficos

• Crear y administrar claves API
• Establecer permisos detallados
• Supervisar el uso de las claves

⚠️ Nota: Aunque puedes añadir y actualizar hosts y claves API directamente en el chat por comodidad, este enfoque está pensado principalmente para casos de uso de desarrollo (como conectarse sobre la marcha a varias instancias). No sigue las mejores prácticas de seguridad de MCP y no debe usarse en entornos de producción sin las protecciones adecuadas.

• Comprobaciones de estado
• Estadísticas del sistema
• Supervisión de tareas
• Información de la versión

Herramientas disponibles

Administración de conexiones

• get-connection-settings: Consultar la URL de conexión actual de Meilisearch y el estado de la clave API
• update-connection-settings: Actualizar la URL o la clave API, o ambas, para conectarse a otra instancia

Administración de índices

• create-index: Crear un índice con una clave primaria opcional
• list-indexes: Enumerar todos los índices disponibles
• delete-index: Eliminar un índice existente y todos sus documentos
• get-index-metrics: Consultar métricas detalladas de un índice específico

Operaciones con documentos

• get-documents: Recuperar documentos de un índice con paginación
• add-documents: Añadir o actualizar documentos en un índice

Búsqueda

• search: Búsqueda flexible en uno o varios índices con opciones de filtrado y ordenación

Administración de ajustes

• get-settings: Consultar los ajustes actuales de un índice
• update-settings: Actualizar los ajustes del índice (clasificación, facetas, etc.)

Administración de claves API

• get-keys: Enumerar todas las claves API
• create-key: Crear una clave API con permisos específicos
• delete-key: Eliminar una clave API existente

Administración de tareas

• get-task: Consultar información sobre una tarea específica
• get-tasks: Enumerar tareas con filtros opcionales
• cancel-tasks: Cancelar tareas pendientes o en cola

Supervisión del sistema

• health-check: Comprobación básica del estado
• get-health-status: Estado general del sistema
• get-version: Consultar información de la versión de Meilisearch
• get-stats: Consultar estadísticas de la base de datos
• get-system-info: Consultar información del sistema

Configuración del entorno de desarrollo

Requisitos previos

1. Inicia el servidor de Meilisearch:

   # Using Docker (recommended for development)
   docker run -d -p 7700:7700 getmeili/meilisearch:v1.28
   
   # Or using brew (macOS)
   brew install meilisearch
   meilisearch
   
   # Or download from https://github.com/meilisearch/meilisearch/releases
   

2. Instala las herramientas de desarrollo:

   # Install uv for Python package management
   pip install uv
   
   # Install Node.js for MCP Inspector testing
   # Visit https://nodejs.org/ or use your package manager
   

Ejecución de pruebas

Este proyecto incluye pruebas de integración exhaustivas que verifican la funcionalidad de las herramientas MCP:

# Run all tests
python -m pytest tests/ -v

# Run specific test file
python -m pytest tests/test_mcp_client.py -v

# Run tests with coverage report
python -m pytest --cov=src tests/

# Run tests in watch mode (requires pytest-watch)
pytest-watch tests/

Importante: Las pruebas requieren una instancia de Meilisearch en ejecución en http://localhost:7700.

Calidad del código

# Format code with Black
black src/ tests/

# Run type checking (if mypy is configured)
mypy src/

# Lint code (if flake8 is configured)
flake8 src/ tests/

Directrices para contribuir

1. Haz un fork y clona el repositorio
2. Configura el entorno de desarrollo siguiendo la sección Configuración del entorno de desarrollo anterior
3. Crea una rama de función a partir de main
4. Escribe primero las pruebas si añades nuevas funciones (desarrollo guiado por pruebas)
5. Ejecuta las pruebas localmente para asegurarte de que todas pasen antes de confirmar los cambios
6. Da formato al código con Black y asegúrate de que cumpla los estándares de calidad
7. Confirma los cambios con mensajes descriptivos
8. Sube los cambios a tu fork y crea una solicitud de incorporación de cambios

Flujo de trabajo de desarrollo

# Create feature branch
git checkout -b feature/your-feature-name

# Make your changes, write tests first
# Edit files...

# Run tests to ensure everything works
python -m pytest tests/ -v

# Format code
black src/ tests/

# Commit and push
git add .
git commit -m "Add feature description"
git push origin feature/your-feature-name

Directrices para las pruebas

• Todas las funciones nuevas deben incluir pruebas
• Las pruebas deben pasar antes de enviar solicitudes de incorporación de cambios
• Usa nombres de prueba descriptivos y aserciones claras
• Prueba tanto los casos de éxito como los de error
• Asegúrate de que Meilisearch esté en ejecución antes de ejecutar las pruebas

Proceso de publicación

Este proyecto usa el control de versiones y la publicación automatizados en PyPI. El proceso de publicación está diseñado para ser sencillo y automatizado.

Cómo funcionan las publicaciones

1. Publicación automatizada: Cuando cambia el número de versión en pyproject.toml en la rama main, una acción de GitHub automáticamente:

   • Compila el paquete de Python
   • Lo publica en PyPI mediante publicación de confianza
   • Crea una nueva versión en GitHub

2. Detección de versiones: El flujo de trabajo compara la versión actual de pyproject.toml con la del commit anterior para detectar cambios

3. Publicación en PyPI: Usa la acción oficial de publicación de PyPA con publicación de confianza (no se necesitan claves API manuales)

Crear una nueva publicación

Para crear una nueva publicación, sigue estos pasos:

1. Determina el número de versión

Sigue el versionado semántico (MAJOR.MINOR.PATCH):

• PATCH (p. ej., 0.4.0 → 0.4.1): Correcciones de errores, actualizaciones de documentación y mejoras menores
• MINOR (p. ej., 0.4.0 → 0.5.0): Nuevas funciones, nuevas herramientas MCP y mejoras importantes
• MAJOR (p. ej., 0.5.0 → 1.0.0): Cambios incompatibles y cambios importantes en la API

2. Actualiza la versión y crea una solicitud de incorporación de cambios

# 1. Create a branch from latest main
git checkout main
git pull origin main
git checkout -b release/v0.5.0

# 2. Update version in pyproject.toml
# Edit the version = "0.4.0" line to your new version

# 3. Commit and push
git add pyproject.toml
git commit -m "Bump version to 0.5.0"
git push origin release/v0.5.0

# 4. Create PR and get it reviewed/merged
gh pr create --title "Release v0.5.0" --body "Bump version for release"

3. Fusiona con Main

Una vez aprobada y fusionada la solicitud de incorporación de cambios en main, la acción de GitHub automáticamente:

1. Detectar el cambio de versión
2. Compilar el paquete
3. Publicar en PyPI en https://pypi.org/p/meilisearch-mcp
4. Poner la nueva versión a disposición mediante pip install meilisearch-mcp

4. Verificar la publicación

Después de fusionar, verifica la publicación:

# Check GitHub Action status
gh run list --workflow=publish.yml

# Verify on PyPI (may take a few minutes)
pip index versions meilisearch-mcp

# Test installation of new version
pip install --upgrade meilisearch-mcp

Archivo del flujo de publicación

La publicación automatizada se gestiona mediante .github/workflows/publish.yml, que:

• Se activa con los envíos a la rama main
• Comprueba si cambió la versión de pyproject.toml
• Usa Python 3.10 y las herramientas oficiales de compilación
• Publica mediante publicación de confianza (no se requieren claves de API)
• Proporciona una salida detallada para la depuración

Solución de problemas de publicación

La publicación no se activó: Comprueba que la versión en pyproject.toml haya cambiado realmente entre las confirmaciones

Error de compilación: Comprueba los registros de GitHub Actions para detectar errores de compilación del paquete de Python

Error al publicar en PyPI: Verifica el nombre del paquete y que la publicación de confianza esté configurada correctamente

Conflictos de versión: Asegúrate de que el nuevo número de versión no se haya usado antes en PyPI

Versiones de desarrollo y producción

• Desarrollo: Instala desde el código fuente usando pip install -e .
• Producción: Instala desde PyPI usando pip install meilisearch-mcp
• Versión específica: Instala usando pip install meilisearch-mcp==0.5.0