OceanBase MCP Server

OceanBase MCP サーバー

OceanBase データベースとの安全なやり取りを可能にする、Model Context Protocol（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 での使用

これを 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 サーバーが機能するには、データベースへのアクセスが必要です。セキュリティを確保するため、以下を実施してください。

1. 必要最小限の権限を持つ専用の OceanBase ユーザーを作成する
2. root 認証情報や管理者アカウントを絶対に使用しない
3. データベースアクセスを必要な操作のみに制限する
4. 監査のためにロギングを有効にする
5. データベースアクセスのセキュリティを定期的に見直す

詳しい手順については、以下を説明する OceanBase Security Configuration Guide を参照してください。

• 制限付き OceanBase ユーザーの作成
• 適切な権限の設定
• データベースアクセスの監視
• セキュリティのベストプラクティス

⚠️ IMPORTANT: データベースアクセスを設定する際は、必ず最小権限の原則に従ってください。

ライセンス

Apache License。詳細については LICENSE ファイルを参照してください。

コントリビューション

1. リポジトリをフォークします
2. 機能ブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m 'Add some amazing feature'）
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します