OceanBase MCP サーバー
OceanBaseデータベースとの安全なやり取りを可能にするモデルコンテキストプロトコル（MCP）サーバー。このサーバーにより、AIアシスタントは制御されたインターフェースを介してテーブルの一覧表示、データの読み取り、SQLクエリの実行が可能になり、データベースの探索と分析をより安全かつ構造化できます。
特徴
- 利用可能な OceanBase テーブルをリソースとして一覧表示する
- 表の内容を読む
- 適切なエラー処理でSQLクエリを実行する
- 環境変数による安全なデータベースアクセス
- 包括的なログ記録
インストール
pip install oceanbase-mcp-server
構成
次の環境変数を設定します。
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
使用法
クロード・デスクトップ
これを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"
}
}
}
}
スタンドアロンサーバーとして
# Install dependencies
pip install -r requirements.txt
# Run the server
python -m oceanbase_mcp_server
発達
# 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
セキュリティに関する考慮事項
- 環境変数や資格情報をコミットしないでください
- 必要最小限の権限を持つデータベースユーザーを使用する
- 本番環境での使用にクエリホワイトリストを実装することを検討する
- すべてのデータベース操作を監視して記録する
セキュリティのベストプラクティス
このMCPサーバーは機能するためにデータベースへのアクセスが必要です。セキュリティのため：
- 最小限の権限を持つ専用のOceanBaseユーザーを作成する
- ルート認証情報や管理者アカウントは使用しないでください
- 必要な操作のみにデータベースアクセスを制限する
- 監査目的でログを有効にする
- データベースアクセスの定期的なセキュリティレビュー
詳細な手順については、 OceanBase セキュリティ構成ガイドを参照してください。
- 制限付きOceanBaseユーザーの作成
- 適切な権限の設定
- データベースアクセスの監視
- セキュリティのベストプラクティス
⚠️ 重要: データベース アクセスを構成するときは、常に最小権限の原則に従ってください。
ライセンス
Apache ライセンス - 詳細については LICENSE ファイルを参照してください。
貢献
- リポジトリをフォークする
- 機能ブランチを作成します（
git checkout -b feature/amazing-feature ） - 変更をコミットします (
git commit -m 'Add some amazing feature' ) - ブランチにプッシュする (
git push origin feature/amazing-feature ) - プルリクエストを開く