Oracle MCP Server

🚀 Oracle MCP サーバー

spring-ai-mcp-server-webmvc-spring-boot-starter をベースにした、Oracle データベース操作を実現する Model Context Protocol (MCP) サービスです。このサービスは、MCP プロトコルを通じて Oracle データベースとやり取りし、Server-Sent Events (SSE) を利用したリアルタイム通信を可能にする一連のツールを提供します。

✨ 主な機能

• Oracle データベース内のすべてのテーブルをリストする
• テーブル構造（列、データ型、制約）を記述する
• SQL 文（SELECT、INSERT、UPDATE、DELETE）を実行する
• 安全なデータベース接続管理
• SSE によるリアルタイム通信
• spring-ai-mcp-server-webmvc-spring-boot-starter をベースに構築

📦 インストール

前提条件

• JDK 17
• Maven 3.6+
• Oracle データベースインスタンス
• MCP サーバー環境
• Cursor IDE

設定

1. データベース設定

application.properties または application.yml を作成または編集し、以下の設定を追加します。

oracle:
  connectionString: jdbc:oracle:thin:@//your-oracle-host:1521/your-service-name
  username: your-username
  password: your-password

2. Cursor MCP 設定

Cursor IDE で MCP サーバーの設定を行います。

{
  "mcpServers": {
    "oracle-mcp-server": {
      "url": "http://{server-ip}:{server-port}/sse",
      "enabled": true
    }
  }
}

この設定では：

• MCP サーバー名を "oracle-mcp-server" に設定します。
• サーバー URL を "http://{server-ip}:{server-port}/sse" に設定します。
  • {server-ip} はサーバーの IP アドレスに置き換えます。
  • {server-port} はサーバーのポート番号に置き換えます。
• Cursor で MCP サーバーを使用できるように有効化します。

プロジェクトのビルド

mvn clean install

アプリケーションの実行

mvn spring-boot:run

💻 使用例

基本的な使用法

以下は、list_tables API を使用して Oracle データベース内のすべてのテーブルを取得する例です。

# ここでは擬似的なコードを示します。実際の使用には適切なライブラリを使用してください。
import requests

response = requests.get('http://{server-ip}:{server-port}/list_tables')
print(response.text)

高度な使用法

execute_query API を使用して任意の SQL クエリを実行する例です。

import requests

query = "SELECT * FROM your_table"
data = {'query_string': query}
response = requests.post('http://{server-ip}:{server-port}/execute_query', json=data)
print(response.json())

📚 ドキュメント

API ツール

1. テーブルリストツール

• 名称：list_tables
• 説明：Oracle データベース内のすべてのテーブルのリストを取得します。
• 使用方法：パラメータ不要
• 戻り値：改行区切りのテーブル名のリスト

2. テーブル記述ツール

• 名称：describe_table
• 説明：指定されたテーブルの構造情報を取得します。
• パラメータ：table_name
• 戻り値：列、データ型、制約などのテーブルの詳細情報

3. SQL 文実行ツール

• 名称：execute_query
• 説明：任意の SQL クエリまたは更新操作を実行します。
• パラメータ：query_string
• 戻り値：クエリ結果セットまたは操作ステータス

🔧 技術詳細

クラス構造

プロジェクトの核心コードは oracle-mcp-server/src/main/java ディレクトリにあり、主に以下のクラスが含まれています。

• OracleMCPHandler.java：MCP プロトコルのリクエストとレスポンスを処理します。
• DatabaseManager.java：データベース接続と操作を管理します。
• TableInfoCollector.java：テーブル構造情報を収集します。
• QueryExecutor.java：SQL クエリと更新を実行します。

機能コンポーネント

1. MCP リクエスト処理：

   • MCP プロトコルのリクエストを解析します。
   • リクエストの合法性を検証します。
   • 対応する機能モジュールを呼び出して処理します。

2. データベース接続管理：

   • Oracle データベースとの接続を確立します。
   • 接続プールを管理します。
   • 接続のライフサイクルを処理します。

3. テーブル構造情報収集：

   • 指定されたテーブルのメタデータを取得します。
   • 列情報を解析します。
   • 構造化された結果を返します。

4. SQL 実行エンジン：

   • SQL 文を分析して実行します。
   • 結果セットを処理します。
   • トランザクションとエラー処理を管理します。

セキュリティに関する考慮事項

• データベース接続文字列は暗号化されて保存されます。
• ユーザーの資格情報は安全なハッシュ処理が施されます。
• アクセス制御リスト（ACL）が管理されます。
• すべての機密操作がログに記録されます。
• SQL インジェクション攻撃から防御されます。

テスト

プロジェクトには、すべての主要な機能モジュールをカバーする完全な単体テストと統合テストセットが用意されています。テストケースには以下が含まれます。

• データベース接続の成功と失敗のケース
• さまざまなタイプの SQL クエリの実行
• テーブル構造情報収集の正確性
• セキュリティメカニズムの有効性
• 境界条件の処理

エラー処理

システムは階層的なエラー処理アーキテクチャを採用しており、以下の機能が含まれています。

• リクエストの検証とパラメータチェック
• 例外のキャプチャとカプセル化
• エラーログの記録
• ユーザーフレンドリーなエラーレスポンス
• トランザクションのロールバックメカニズム

コントリビューションガイド

コミュニティからのコードの貢献や問題の報告を歓迎します。詳細なコントリビューションフローについては、プロジェクトリポジトリの CONTRIBUTING.md ファイルを参照してください。

📄 ライセンス

このプロジェクトは Apache License 2.0 でライセンスされており、詳細は LICENSE ファイルを参照してください。