OceanBase MCP Server

OceanBase MCP Server

Um servidor Model Context Protocol (MCP) que permite interação segura com bancos de dados OceanBase. Este servidor permite que assistentes de IA listem tabelas, leiam dados e executem consultas SQL por meio de uma interface controlada, tornando a exploração e análise de bancos de dados mais segura e estruturada.

Recursos

• Listar tabelas OceanBase disponíveis como recursos
• Ler o conteúdo das tabelas
• Executar consultas SQL com tratamento adequado de erros
• Acesso seguro ao banco de dados por meio de variáveis de ambiente
• Registro de logs abrangente

Instalação

pip install oceanbase-mcp-server

Configuração

Defina as seguintes variáveis de ambiente:

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

Com o Claude Desktop

Adicione isto ao seu 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 autônomo

# Install dependencies
pip install -r requirements.txt

# Run the server
python -m oceanbase_mcp_server

Desenvolvimento

# 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

Considerações de Segurança

• Nunca faça commit de variáveis de ambiente ou credenciais
• Use um usuário de banco de dados com as permissões mínimas necessárias
• Considere implementar uma lista de permissões de consultas para uso em produção
• Monitore e registre todas as operações do banco de dados

Boas Práticas de Segurança

Este servidor MCP requer acesso ao banco de dados para funcionar. Por segurança:

1. Crie um usuário OceanBase dedicado com permissões mínimas
2. Nunca use credenciais de root ou contas administrativas
3. Restrinja o acesso ao banco de dados apenas às operações necessárias
4. Ative o registro de logs para fins de auditoria
5. Revisões regulares de segurança do acesso ao banco de dados

Consulte o Guia de Configuração de Segurança do OceanBase para instruções detalhadas sobre:

• Criar um usuário OceanBase restrito
• Definir permissões apropriadas
• Monitorar o acesso ao banco de dados
• Boas práticas de segurança

⚠️ IMPORTANTE: Sempre siga o princípio do menor privilégio ao configurar o acesso ao banco de dados.

Licença

Licença Apache - consulte o arquivo LICENSE para obter detalhes.

Contribuição

1. Faça um fork do repositório
2. Crie sua branch de recurso (git checkout -b feature/amazing-feature)
3. Faça commit das suas alterações (git commit -m 'Add some amazing feature')
4. Envie para a branch (git push origin feature/amazing-feature)
5. Abra um Pull Request