SingleStore MCP Server

Servidor MCP de SingleStore

El Protocolo de Contexto de Modelo (MCP) es un protocolo estandarizado diseñado para gestionar el contexto entre grandes modelos de lenguaje (LLM) y sistemas externos. Este repositorio proporciona un instalador y un servidor MCP para Singlestore, lo que permite una integración fluida.

Con MCP, puedes usar Claude Desktop, Cursor o cualquier cliente MCP compatible para interactuar con SingleStore usando lenguaje natural, lo que facilita la realización de operaciones complejas sin esfuerzo.

Requisitos

• Python >= v3.11.0
• uvx instalado en su entorno de Python
• Claude Desktop, Cursor u otro cliente LLM compatible

Configuración del cliente

1. Comando Init

La forma más sencilla de configurar el servidor MCP es utilizar el comando de inicialización:

Este comando hará lo siguiente:

1. Autenticar al usuario
2. Localiza automáticamente el archivo de configuración para tu plataforma
3. Cree o actualice la configuración para incluir el servidor SingleStore MCP
4. Proporcionar instrucciones para iniciar el servidor

También puedes pasar explícitamente una <SINGLESTORE_API_KEY> :

Para especificar un cliente (por ejemplo, claude o cursor ), utilice el indicador --client :

2. Instalación mediante herrería

Para instalar mcp-server-singlestore automáticamente a través de Smithery :

Reemplace <client> con claude o cursor según sea necesario.

3. Configuración manual

Escritorio y cursor de Claude

1. Agregue la siguiente configuración a su archivo de configuración de cliente:

• Escritorio de Claude :
• Cursor
  { "mcpServers": { "singlestore-mcp-server": { "command": "uvx", "args": [ "singlestore-mcp-server", "start", "<SINGLESTORE_API_KEY>" ] } } }

2. Reinicie su cliente después de realizar cambios en la configuración.

Componentes

Herramientas

El servidor implementa las siguientes herramientas:

• workspace_groups_info : recupera detalles sobre los grupos de espacios de trabajo accesibles para el usuario
  • No se requieren argumentos
  • Devuelve detalles de los grupos de espacios de trabajo
• workspaces_info : recupera detalles sobre los espacios de trabajo en un grupo de espacios de trabajo específico
  • Argumentos: workspaceGroupID (cadena)
  • Devuelve detalles de los espacios de trabajo.
• organization_info : recupera detalles sobre la organización actual del usuario
  • No se requieren argumentos
  • Devuelve detalles de la organización.
• list_of_regions : recupera una lista de todas las regiones que admiten espacios de trabajo para el usuario
  • No se requieren argumentos
  • Devuelve una lista de regiones
• execute_sql : Ejecutar operaciones SQL en un espacio de trabajo conectado
  • Argumentos: workspace_group_identifier , workspace_identifier , username , password , database , sql_query
  • Devuelve los resultados de la consulta SQL en un formato estructurado
• list_virtual_workspaces : enumera todos los espacios de trabajo de inicio accesibles para el usuario
  • No se requieren argumentos
  • Devuelve detalles de los espacios de trabajo de inicio disponibles
• create_virtual_workspace : Crea un nuevo espacio de trabajo de inicio con un usuario
  • Argumentos:
    • name : Nombre del espacio de trabajo de inicio
    • database_name : Nombre de la base de datos a crear
    • username : Nombre de usuario para acceder al espacio de trabajo
    • password : Contraseña del usuario
    • workspace_group : Objeto que contiene name (opcional) y cellID (obligatorio)
  • Devuelve detalles del espacio de trabajo creado y del usuario.
• execute_sql_on_virtual_workspace : Ejecutar operaciones SQL en un espacio de trabajo virtual
  • Argumentos: virtual_workspace_id , username , password , sql_query
  • Devuelve los resultados de la consulta SQL en un formato estructurado que incluye datos, recuento de filas, columnas y estado.
• list_notebook_samples : Lista todos los ejemplos de cuadernos disponibles en SingleStore Spaces
  • No se requieren argumentos
  • Devuelve detalles de las muestras de cuadernos disponibles
• create_notebook : Crea un nuevo cuaderno en el espacio personal del usuario
  • Argumentos: notebook_name , content (opcional)
  • Devuelve detalles del cuaderno creado
• list_personal_files : enumera todos los archivos en el espacio personal del usuario
  • No se requieren argumentos
  • Devuelve detalles de todos los archivos en el espacio personal del usuario.
• create_scheduled_job : crea un nuevo trabajo programado para ejecutar un cuaderno
  • Argumentos:
    • name : Nombre para el trabajo
    • notebook_path : Ruta al notebook a ejecutar
    • schedule_mode : Una vez o recurrente
    • execution_interval_minutes : Minutos entre ejecuciones (opcional)
    • start_at : Cuándo iniciar el trabajo (opcional)
    • description : Descripción del puesto de trabajo (opcional)
    • create_snapshot : Si se deben crear instantáneas del cuaderno (opcional)
    • runtime_name : Nombre del entorno de ejecución
    • parameters : Parámetros para el trabajo (opcional)
    • target_config : Configuración de destino para el trabajo (opcional)
  • Devuelve detalles del trabajo creado
• get_job_details : Obtener detalles sobre un trabajo específico
  • Argumentos: job_id
  • Devuelve información detallada sobre el trabajo especificado
• list_job_executions : enumera el historial de ejecución de un trabajo específico
  • Argumentos: job_id , start (opcional), end (opcional)
  • Devuelve el historial de ejecución del trabajo especificado

Dockerización

Construyendo la imagen de Docker

Para crear la imagen de Docker para el servidor MCP, ejecute el siguiente comando en la raíz del proyecto:

Ejecución del contenedor Docker

Para ejecutar el contenedor Docker, utilice el siguiente comando:

Uso de Docker Secrets

Para pasar secretos de forma segura al contenedor, cree un secreto de Docker y móntelo:

Luego, ejecuta el contenedor con el secreto: