README Documentation
MyPos MCP DB
Este es un proyecto de ejemplo para un Model-Context-Protocol (MCP) Server que se conecta a una base de datos.
Características
- Se conecta a bases de datos MySQL o PostgreSQL.
- Proporciona herramientas para interactuar con la base de datos y administrar el esquema.
Herramientas disponibles
- listarTablas: Enumera todas las tablas en la base de datos.
- consultarSQL: Ejecuta una consulta
SELECT
y devuelve los resultados. - columnasDeTabla: Enumera las columnas de una tabla específica.
- crearTabla: Crea una nueva tabla a partir de un objeto de definición.
- eliminarTabla: Elimina una tabla de la base de datos.
- renombrarTabla: Cambia el nombre de una tabla existente.
- agregarColumna: Agrega una nueva columna a una tabla existente.
- eliminarColumna: Elimina una columna de una tabla.
- renombrarColumna: Cambia el nombre de una columna en una tabla.
- cambiarTipoColumna: Cambia el tipo de datos de una columna (por ejemplo, a DATE, VARCHAR, etc).
- insertarDatos: Inserta uno o varios registros en una tabla.
- crudTabla: Permite realizar operaciones CRUD (crear, leer, actualizar, borrar) en cualquier tabla.
- agregarClaveForanea: Agrega una clave foránea (FOREIGN KEY) entre tablas.
- eliminarClaveForanea: Elimina una clave foránea por nombre.
- exportarTabla: Exporta los datos de una tabla o columnas específicas a CSV o JSON.
- importarTabla: Importa datos a una tabla desde CSV o JSON, permitiendo especificar columnas.
Requisitos
- Node.js (v16 o superior)
- Una base de datos MySQL o PostgreSQL en ejecución.
Configuración
-
Clonar el repositorio:
git clone https://github.com/Yonsn76/MyPos-MCP.git cd MyPos-MCP
-
Instalar dependencias:
npm install
-
Configurar las variables de entorno:
Crea un archivo
.env
en la raíz del proyecto y añade las siguientes variables:DB_TYPE=mysql # o postgres DB_HOST=localhost DB_PORT=3306 # o 5432 para postgres DB_USER=root DB_PASSWORD=tu_contraseña DB_DATABASE=nombre_de_la_base_de_datos
Uso
Para iniciar el servidor MCP, ejecuta:
npm start
El servidor se iniciará y se conectará a la base de datos especificada en el archivo .env
.
Ejemplo de Configuración MCP
Para usar este MCP, puedes agregarlo a tu configuración con el siguiente objeto:
"MyPost MCP": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"node",
"C:/Users/Pociko/Desktop/MCP/legion-mcp/Mi-mcp/mcp_server.js"
//Aqui va la url del directorio en la cual esta el archivo mcp_server.js
]
}
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source