Oceanbase

🚀 OceanBase MCP サーバー

OceanBase MCP サーバーは、OceanBase データベースとのやり取りを容易にするツールです。利用可能な表の一覧表示、表内容の読み取り、SQL クエリの実行などの機能を提供します。

✨ 主な機能

• OceanBase の利用可能な表をリソースとして列挙します。
• 表の内容を読み取ります。
• SQL クエリを実行し、適切なエラー処理を行います。
• 環境変数を通じてデータベースへの安全なアクセスを実現します。
• 包括的なログ記録を行います。

📦 インストール

pip install oceanbase-mcp-server

📚 ドキュメント

設定

以下の環境変数を設定してください。

OB_HOST=localhost     # データベースホスト
OB_PORT=2881         # オプション：データベースポート（指定しない場合は 2881 がデフォルト）
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"
      }
    }
  }
}

独立したサーバーとしての実行

# 依存関係のインストール
pip install -r requirements.txt

# サーバーの起動
python -m oceanbase_mcp_server

開発

# リポジトリのクローン
git clone https://github.com/yourusername/oceanbase_mcp_server.git
cd oceanbase_mcp_server

# 仮想環境の作成
python -m venv venv
source venv/bin/activate  # または Windows では `venv\Scripts\activate`

# 開発用依存関係のインストール
pip install -r requirements-dev.txt

# テストの実行
pytest

セキュリティに関する注意事項

• 環境変数や認証情報を決してコミットしないでください。
• 最小限の権限を持つデータベースユーザーを使用してください。
• 本番環境ではクエリホワイトリストを実装することを検討してください。
• すべてのデータベース操作を監視し、記録してください。

セキュリティのベストプラクティス

この MCP サーバーは、データベースへのアクセス権限が必要です。セキュリティ上の理由から、以下の手順を実行してください。

1. 専用の OceanBase ユーザーを作成 し、最小限の権限を付与します。
2. root の認証情報 や管理アカウントを使用しないでください。
3. データベースアクセスを制限 し、必要な操作のみを許可します。
4. ログ記録を有効化 して監査を行います。
5. 定期的にセキュリティレビュー を行い、データベースアクセスを確認します。

詳細な説明については、OceanBase セキュリティ構成ガイド を参照してください。

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

⚠️ 注意：データベースアクセスを構成する際は、常に最小特権の原則に従ってください。

貢献ガイド

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

📄 ライセンス

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