MCP Postgres Query Server

Servidor de Consultas Postgres MCP

Una implementación de servidor de Protocolo de Contexto de Modelo (MCP) para consultar una base de datos PostgreSQL en modo de solo lectura, diseñado para funcionar con Claude Desktop y otros clientes MCP.

Descripción general

Este proyecto implementa un servidor de Protocolo de Contexto de Modelo (MCP) que proporciona:

1. Una interfaz segura y de solo lectura para una base de datos PostgreSQL
2. Integración con Claude Desktop a través del protocolo MCP
3. Validación de consultas SQL para garantizar que solo se ejecuten consultas SELECT
4. Protección de tiempo de espera de consultas (10 segundos)

Requisitos previos

• Node.js (v14 o posterior)
• npm (incluido con Node.js)
• Base de datos PostgreSQL (los detalles de conexión se proporcionan mediante la línea de comandos)

Instalación

# Clone the repository
git clone https://github.com/RathodDarshil/mcp-postgres-query-server.git
cd mcp-postgres-query-server

# Install dependencies
npm install

# Build the project
npm run build

Conexión con Claude Desktop

Puede configurar Claude Desktop para que inicie y se conecte automáticamente al servidor MCP:

1. Acceda al archivo de configuración de Claude Desktop:

   • Abra Claude Desktop
   • Vaya a Configuración > Desarrollador > Editar configuración
   • Esto abrirá el archivo de configuración en su editor de texto predeterminado

2. Agregue postgres-query-server a la sección mcpServers de su claude_desktop_config.json:

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/path/to/your/mcp-postgres-query-server/dist/index.js",
                "postgresql://username:password@hostname:port/database"
            ]
        }
    }
}

3. Reemplace /path/to/your/ con la ruta real a su directorio de proyecto.
4. Reemplace la cadena de conexión de PostgreSQL con sus credenciales reales de base de datos.
5. Guarde el archivo y reinicie Claude Desktop. El servidor MCP ahora debería aparecer en el menú desplegable de selección de servidores MCP en Configuración.

Ejemplo de configuración

Aquí hay un ejemplo completo de un archivo de configuración con postgres-query:

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/Users/darshilrathod/mcp-servers/mcp-postgres-query-server/dist/index.js",
                "postgresql://user:password@localhost:5432/mydatabase"
            ]
        }
    }
}

Actualización de la configuración

Para actualizar su configuración de Claude Desktop:

1. Abra Claude Desktop
2. Vaya a Configuración > Desarrollador > Editar configuración
3. Realice sus cambios en el archivo de configuración
4. Guarde el archivo
5. Reinicie Claude Desktop para que los cambios surtan efecto
6. Si ha actualizado el código del servidor MCP, asegúrese de reconstruirlo con npm run build antes de reiniciar

Características

• Acceso de solo lectura a la base de datos: Solo se permiten consultas SELECT por seguridad
• Validación de consultas: Previene operaciones SQL potencialmente dañinas
• Protección de tiempo de espera: Las consultas que se ejecutan durante más de 10 segundos se terminan automáticamente
• Soporte del protocolo MCP: Implementación completa del Protocolo de Contexto de Modelo
• Formato de respuesta JSON: Los resultados de las consultas se devuelven en formato JSON estructurado

API

Herramientas

query-postgres

Ejecuta una consulta SQL de solo lectura contra la base de datos PostgreSQL configurada.

Parámetros:

• query (cadena): Una consulta SQL SELECT para ejecutar

Respuesta:

• Objeto JSON que contiene:
  • rows: Las filas del conjunto de resultados
  • rowCount: Número de filas devueltas
  • fields: Metadatos de columnas

Ejemplo:

query-postgres: SELECT * FROM users LIMIT 5

Desarrollo

La implementación principal del servidor está en src/index.ts. Componentes clave:

• Configuración del grupo de conexiones de PostgreSQL
• Lógica de validación de consultas
• Configuración del servidor MCP
• Definiciones de herramientas y recursos

Para modificar el comportamiento del servidor, puede:

• Editar la lógica de validación de consultas en isReadOnlyQuery()
• Agregar herramientas o recursos adicionales al servidor MCP
• Modificar la duración del tiempo de espera de consultas (actualmente 10 segundos)

Consideraciones de seguridad

• El servidor valida todas las consultas para garantizar que sean de solo lectura
• La conexión a la base de datos utiliza SSL
• El tiempo de espera de consultas evita el agotamiento de recursos
• No se permiten operaciones de escritura
• Las credenciales de la base de datos se pasan directamente mediante argumentos de línea de comandos, no se almacenan en archivos

Licencia

ISC

Contribuciones

¡Las contribuciones son bienvenidas! No dude en enviar una Solicitud de extracción (Pull Request).