OceanBase MCP Server

OceanBase MCP Server

Un servidor de Model Context Protocol (MCP) que permite la interacción segura con bases de datos OceanBase. Este servidor permite a los asistentes de IA listar tablas, leer datos y ejecutar consultas SQL a través de una interfaz controlada, haciendo que la exploración y el análisis de bases de datos sean más seguros y estructurados.

Características

• Listar tablas disponibles de OceanBase como recursos
• Leer el contenido de las tablas
• Ejecutar consultas SQL con manejo adecuado de errores
• Acceso seguro a la base de datos mediante variables de entorno
• Registro (logging) integral

Instalación

pip install oceanbase-mcp-server

Configuración

Establezca las siguientes variables de entorno:

OB_HOST=localhost     # Database host
OB_PORT=2881         # Optional: Database port (defaults to 2881 if not specified)
OB_USER=your_username
OB_PASSWORD=your_password
OB_DATABASE=your_database

Uso

Con Claude Desktop

Agregue esto a su claude_desktop_config.json:

{
  "mcpServers": {
    "oceanbase": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/oceanbase_mcp_server",
        "run",
        "oceanbase_mcp_server"
      ],
      "env": {
        "OB_HOST": "localhost",
        "OB_PORT": "2881",
        "OB_USER": "your_username",
        "OB_PASSWORD": "your_password",
        "OB_DATABASE": "your_database"
      }
    }
  }
}

Como servidor independiente

# Install dependencies
pip install -r requirements.txt

# Run the server
python -m oceanbase_mcp_server

Desarrollo

# Clone the repository
git clone https://github.com/yourusername/oceanbase_mcp_server.git
cd oceanbase_mcp_server

# Create virtual environment
python -m venv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows

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

# Run tests
pytest

Consideraciones de seguridad

• Nunca confirme (commitee) variables de entorno o credenciales
• Utilice un usuario de base de datos con los permisos mínimos necesarios
• Considere implementar listas blancas de consultas para uso en producción
• Monitoree y registre todas las operaciones de la base de datos

Mejores prácticas de seguridad

Este servidor MCP requiere acceso a la base de datos para funcionar. Por seguridad:

1. Cree un usuario dedicado de OceanBase con permisos mínimos
2. Nunca use credenciales de root ni cuentas administrativas
3. Restrinja el acceso a la base de datos solo a las operaciones necesarias
4. Habilite el registro (logging) con fines de auditoría
5. Realice revisiones de seguridad periódicas del acceso a la base de datos

Consulte la Guía de configuración de seguridad de OceanBase para obtener instrucciones detalladas sobre:

• Crear un usuario restringido de OceanBase
• Establecer permisos apropiados
• Monitorear el acceso a la base de datos
• Mejores prácticas de seguridad

⚠️ IMPORTANTE: Siga siempre el principio de privilegio mínimo al configurar el acceso a la base de datos.

Licencia

Licencia Apache: consulte el archivo LICENSE para obtener más detalles.

Contribuciones

1. Haga un fork del repositorio
2. Cree su rama de características (git checkout -b feature/amazing-feature)
3. Confirme sus cambios (git commit -m 'Add some amazing feature')
4. Haga push a la rama (git push origin feature/amazing-feature)
5. Abra un Pull Request