Oceanbase MCP Server

🚀 OceanBase MCP サーバー

このプロジェクトはOceanBaseデータベースを操作するためのMCPサーバーで、表の一覧表示、内容の読み取り、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. Pull Requestを開きます。

📄 ライセンス

Apacheライセンス - 詳細はLICENSEファイルを参照してください。