Servidor MCP para PostgreSQL

Una implementación de servidor de Protocolo de Contexto de Modelo (MCP) para PostgreSQL, que proporciona una interfaz simple para interactuar con bases de datos PostgreSQL a través de MCP.

Características

• Ejecutar consultas SQL con entradas parametrizadas

• Ejecutar operaciones INSERTAR/ACTUALIZAR/ELIMINAR

• Crear nuevas bases de datos

• Crear o actualizar esquemas de tablas

• Depurar conexiones PostgreSQL

• En contenedores con Docker para una fácil implementación

• Configuración basada en el entorno

Related MCP server: MCP PostgreSQL Server

Prerrequisitos

• Python 3.8+

• PostgreSQL 10+

• Docker (opcional, para implementación en contenedores)

• Docker Compose (opcional, para desarrollo)

Instalación

Uso de Docker (recomendado)

1. Clonar el repositorio:

   git clone https://github.com/asadudin/mcp-server-postgres.git
   cd mcp-server-postgres

2. Copie el archivo de entorno de ejemplo:

   cp .env.example .env

3. Actualice el archivo .env con sus credenciales de PostgreSQL:

   PG_HOST=postgres
   PG_PORT=5432
   PG_USER=postgres
   PG_PASSWORD=your_password
   PG_DATABASE=your_database
   HOST=0.0.0.0
   PORT=8056

4. Inicie el servicio usando Docker Compose:

   docker-compose up -d

Instalación manual

1. Clonar el repositorio:

   git clone https://github.com/asadudin/mcp-server-postgres.git
   cd mcp-server-postgres

2. Crear y activar un entorno virtual:

   python -m venv venv
   source venv/bin/activate  # On Windows: .\venv\Scripts\activate

3. Instalar dependencias:

   pip install -r requirements.txt

4. Copie el archivo de entorno de ejemplo y actualícelo:

   cp .env.example .env
   # Edit .env with your configuration

5. Ejecutar el servidor:

   python mcp_server_postgres.py

Uso

El servidor MCP proporciona los siguientes puntos finales:

sql_query

Ejecute una consulta SELECT y devuelva los resultados como JSON.

Parámetros:

• query : cadena de consulta SQL

• params : cadena JSON opcional de parámetros de consulta (lista o diccionario)

Ejemplo:

{
  "query": "SELECT * FROM users WHERE id = $1",
  "params": [1]
}

sql_execute

Ejecutar una instrucción INSERT/UPDATE/DELETE.

Parámetros:

• query : instrucción SQL

• params : cadena JSON opcional de parámetros de consulta (lista o diccionario)

Ejemplo:

{
  "query": "INSERT INTO users (name, email) VALUES ($1, $2)",
  "params": ["John Doe", "john@example.com"]
}

create_database

Crear una nueva base de datos PostgreSQL.

Parámetros:

• database_name : Nombre de la base de datos a crear

create_or_update_table

Crear o actualizar un esquema de tabla.

Parámetros:

• sql : instrucción SQL CREATE TABLE o ALTER TABLE

debug_postgres_connection

Depurar la conexión PostgreSQL.

Variables de entorno

Desarrollo

Ejecución de pruebas

# Install test dependencies
pip install -r requirements-dev.txt

# Run tests
pytest

Construyendo la imagen de Docker

docker build -t mcp-server-postgres .

Documentación de la API

Para obtener documentación detallada de la API, consulte la especificación OpenAPI .

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

Expresiones de gratitud

• FastMCP : el marco del servidor MCP

• asyncpg - Cliente PostgreSQL para Python

• FastAPI : un marco web moderno y rápido para crear API