View a markdown version of this page

OpenSearch Servidor MCP - OpenSearch Servicio Amazon

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

OpenSearch Servidor MCP

OpenSearch El servidor MCP (opensearch-mcp-server-py) es una implementación de código abierto del Model Context Protocol para. OpenSearch Se presenta OpenSearch APIs como herramientas a las que los asistentes de IA y los marcos de agentes pueden recurrir directamente, por lo que puede hacer preguntas como «¿Qué índices existen en mi clúster?» o «Muéstrame las consultas más lentas de la última hora» y el agente gestionará las llamadas a la API en tu nombre.

El servidor funciona tanto con dominios de OpenSearch servicio gestionados como con colecciones OpenSearch sin servidor. Puede conectarlo a la programación IDEs (Kiro, Claude Code, Cursor), a los asistentes de IA de escritorio (Claude Desktop) y a los marcos de agentes (Strands Agents). LangGraph

Requisitos previos

  • Python 3.10 o posterior.

  • uv(recomendado) o. pip

  • Un OpenSearch punto final accesible: un dominio de OpenSearch servicio, una colección OpenSearch sin servidor o un clúster OpenSearch autogestionado.

  • Credenciales con permiso para llamar al OpenSearch APIs que desea exponer. Para obtener información sobre las políticas de IAM en los dominios de OpenSearch servicio, consultePolíticas basadas en identidades. Para conocer las políticas de acceso a datos OpenSearch sin servidor, consulte. Control de acceso a datos para Amazon OpenSearch Serverless

Instalación

Ejecute el servidor con uvx (no requiere instalación) o instálelo localmente:

# Run directly with uvx (recommended – no install step) uvx opensearch-mcp-server-py # Or install with pip pip install opensearch-mcp-server-py

La mayoría de los usuarios configuran su IDE o asistente de IA para iniciar el servidor automáticamente. Consulte Configure en un IDE de codificación y Úselo con marcos de agentes para ver ejemplos.

Autenticación

Configure la autenticación mediante variables de entorno (modo de un solo clúster) o por clúster en un archivo de configuración YAML (modo de varios clústeres). El servidor aplica los métodos de autenticación en el siguiente orden de prioridad: sin autenticación, basados en encabezados, función de IAM, autenticación básica y claves de acceso. AWS

Función de IAM (SiGv4): recomendada para los dominios de servicio OpenSearch
export OPENSEARCH_URL="https://your-domain-endpoint" export AWS_IAM_ARN="arn:aws:iam::123456789012:role/YourOpenSearchRole" export AWS_REGION="us-east-1"

El rol debe tener permiso para llamar al que utiliza OpenSearch APIs el servidor. Consulte Políticas de muestra adicionales para ver ejemplos de políticas.

AWS credenciales o perfil
export OPENSEARCH_URL="https://your-domain-endpoint" export AWS_REGION="us-east-1" export AWS_PROFILE="your-aws-profile"
OpenSearch Colecciones sin servidor

AWS_OPENSEARCH_SERVERLESS=trueConfigúrelo de forma que el servidor firme las solicitudes con el nombre del aoss servicio en lugar dees. Asegúrese de que se conceda el acceso al director mediante una política de acceso a los datos sobre la recopilación (consulteControl de acceso a datos para Amazon OpenSearch Serverless).

export OPENSEARCH_URL="https://collection-id.us-east-1.aoss.amazonaws.com" export AWS_OPENSEARCH_SERVERLESS="true" export AWS_REGION="us-east-1" export AWS_PROFILE="your-aws-profile"
Autenticación básica
export OPENSEARCH_URL="https://your-domain-endpoint" export OPENSEARCH_USERNAME="username" export OPENSEARCH_PASSWORD="password"
importante

No inserte contraseñas en los archivos de configuración que puedan estar registrados en el control de código fuente. Utilice el administrador secreto o el entorno de shell de su sistema operativo para proporcionar las credenciales.

Consideraciones de seguridad

El servidor MCP se ejecuta con las credenciales que usted proporcione. El asistente de IA puede activar cualquier cosa que esas credenciales estén autorizadas a hacer en tu nombre. Siga estas prácticas:

  • Utilice credenciales con privilegios mínimos. Cree un rol o OpenSearch usuario de IAM dedicado a los índices y acciones que necesite el agente. Evite reutilizar las credenciales de administrador.

  • Desarrollo y producción separados. Dirija el servidor a los clústeres que no son de producción para su exploración. Utilice el modo múltiple con nombres de clúster explícitos cuando se requiera el acceso a la producción.

  • Herramientas de filtrado. Deshabilita las categorías de herramientas que tu flujo de trabajo no necesita. Configúrelo OPENSEARCH_DISABLED_CATEGORIES=core_tools para deshabilitar el conjunto predeterminado o OPENSEARCH_ENABLED_CATEGORIES utilícelo para habilitar solo categorías específicas.

  • Proteja las credenciales. Prefiera AWS los perfiles y las funciones de IAM a las claves de acceso estáticas. Nunca guarde secretos en los archivos de configuración del control de código fuente.

  • Revise el resultado de la herramienta. Las respuestas de la herramienta MCP se retroalimentan al modelo de lenguaje como contexto. Evite ejecutar el servidor con índices que contengan datos confidenciales que no desee que su proveedor de IA conozca.

Resolución de problemas

El asistente no ve ninguna herramienta OpenSearch

Confirme que su archivo de configuración es un JSON válido y reinicie el cliente por completo. La mayoría de los clientes solo cargan los servidores MCP al inicio.

Las llamadas a las herramientas devuelven 403 Forbidden

Sus credenciales no tienen permiso para la API a la que llama la herramienta. En el OpenSearch caso de los dominios de servicio, revise la política de acceso al dominio y las políticas de IAM asociadas a su función. En el caso de OpenSearch Serverless, revise la política de acceso a los datos de la colección.

Errores de discordancia de firmas con Serverless OpenSearch

Asegúrese de que AWS_OPENSEARCH_SERVERLESS=true esté configurado (o is_serverless: true en modo múltiple). Sin él, el servidor firma con el nombre del es servicio en lugar deaoss.

La herramienta que necesita no está disponible

Comprueba si se encuentra en una categoría no predeterminada y habilítala con OPENSEARCH_ENABLED_CATEGORIES o enabled_categories en tu configuración de YAML.

Para obtener más ayuda, abre una edición en el opensearch-mcp-server-py repositorio.

Recursos adicionales