CockroachDB MCP Server

Servidor MCP de CockroachDB

Este servidor MCP se conecta a una instancia de CockroachDB, exponiendo esquemas de bases de datos y tablas como recursos, ejecutando consultas SQL como herramientas y proporcionando indicaciones para el análisis de consultas.

Características

Recursos

• postgres://{host}/databases/{database} - Obtener información sobre una base de datos específica
• postgres://{host}/databases/{database}/tables/{table}/schema - Obtener el esquema para una tabla específica
• postgres://{host}/cluster-metadata/{resource} - Obtener metadatos del clúster (requiere token de autenticación)
  • Actualmente admite: nodes : información sobre los nodos del clúster

Herramientas

• query - Ejecutar una consulta SQL con opciones para el análisis del plan de ejecución

Instalación

1. Clonar este repositorio
2. Instalar dependencias:
   pnpm install
3. Construir el proyecto:
   npx tsc

Nota: debe compilar el proyecto con tsc antes de usar el servidor MCP localmente.

Configuración

El servidor requiere una URL de base de datos como argumento de línea de comandos y, opcionalmente, acepta un token de autenticación para acceder a los puntos finales de la interfaz de usuario de administración:

El token de autorización es necesario para acceder a los recursos de metadatos del clúster.

Uso con Claude para escritorio

1. Abra la configuración de la aplicación Claude para escritorio:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Ventanas: %APPDATA%\Claude\claude_desktop_config.json
2. Añade la configuración de tu servidor:

3. Reiniciar Claude para escritorio

Uso con Cline

1. Abra el archivo de configuración de Cline desde la configuración de la extensión, en "Servidores MCP". Seleccione "Configurar servidores MCP".
2. Añade la configuración de tu servidor:

3. Reiniciar Cline o iniciar una nueva sesión

Consultas de ejemplo

A continuación se muestran algunos ejemplos de preguntas que puedes hacerle a Claude:

1. "¿Qué bases de datos están disponibles en mi instancia de CockroachDB?"
2. "¿Puede mostrarme el esquema de la tabla 'usuarios' en la base de datos 'testdb'?"
3. "Ejecute esta consulta en mi base de datos: SELECT * FROM users LIMIT 10"
4. Depurar esta consulta y sugerir mejoras: SELECT * FROM orders WHERE customer_id = 123
5. "Muéstrame información sobre todos los nodos de mi clúster CockroachDB"

Consideraciones de seguridad

• Tenga cuidado al configurar el acceso a la base de datos. Considere usar un usuario de solo lectura para la conexión si solo necesita consultar datos.
• El token de autenticación se utiliza para acceder a la API de la interfaz de usuario de administración de CockroachDB. Asegúrese de mantener este token seguro.

Solución de problemas

• Si encuentra problemas de conexión, verifique las credenciales de su base de datos y asegúrese de que la instancia de CockroachDB sea accesible desde su máquina.
• Para errores de SQL, consulte los registros del servidor para obtener mensajes de error detallados.
• Si Claude no puede ver el servidor, verifique que el archivo de configuración esté correctamente formateado y que la ruta al archivo server.js sea correcta.
• Para los recursos de metadatos del clúster, asegúrese de haber proporcionado un token de autenticación válido y de que la interfaz de usuario de administración sea accesible en el puerto 8080.