OceanBase MCP ServerとTraeの連携

MCP（Model Context Protocol）は、Anthropic社が2024年11月に発表し、オープンソース化したプロトコルです。大規模言語モデル（LLM）が外部のツールやデータソースと直接やり取りできるよう設計されています。MCPを使えば、ユーザーがLLMの出力をコピー＆ペーストして手動で実行する必要はなく、LLMからツールへ直接指示を送り、そのままアクションを実行させることが可能になります。

OceanBase MCP Serverは、MCPプロトコルを介して大規模言語モデルとOceanBaseデータベースを連携させ、SQL文の実行を可能にするサーバーです。GitHubでオープンソースとして公開されており、対応するクライアントを利用すれば、プロジェクトのプロトタイプを素早く構築できます。

Traeは、MCP Serverと連携できるIDEで、公式サイトから最新バージョンを入手可能です。

本記事では、Trae IDEとOceanBase MCP Serverを組み合わせ、バックエンドアプリケーションを迅速に構築する手順を紹介します。

前提条件

• OceanBaseデータベースのデプロイが完了し、MySQLモードのユーザーテナントが作成されていること。テナント作成の詳細については、テナントの作成を参照してください。

• Python 3.11以降のバージョンと対応するpipをインストールします。お使いのマシンにインストールされているPythonのバージョンが古い場合は、Minicondaを使用してPython 3.11以降の新しい環境を作成することができます。詳細はMinicondaインストールガイドを参照してください。

• お使いのオペレーティングシステムに応じて、Gitをインストールします。

• Pythonパッケージマネージャーのuvをインストールします。インストール完了後、uv --versionコマンドでインストールが成功したかを確認できます。

  pip install uv
  uv --version
  

• Trae IDEをダウンロードし、お使いのオペレーティングシステムに合った適切なバージョンを選択してインストールします。

ステップ1：データベース接続情報を取得する

OceanBaseデータベースのデプロイ担当者または管理者に連絡し、対応するデータベース接続文字列を取得します。例：

obclient -h$host -P$port -u$user_name -p$password -D$database_name

パラメータの説明：

• $host：OceanBaseデータベースへの接続IPアドレスです。OceanBaseデータベースプロキシ(OceanBase Database Proxy、ODP)経由で接続する場合はODPのアドレスを、直接接続する場合はOBServerノードのIPアドレスを使用します。

• $port：OceanBaseデータベースの接続ポートです。ODP経由の接続ではデフォルトで2883が使用されますが、ODPのデプロイ時にカスタマイズ可能です。直接接続の場合はデフォルトで2881が使用され、OceanBaseデータベースのデプロイ時にカスタマイズできます。

• $database_name：アクセスするデータベースの名前です。

  注意

  テナントに接続するユーザーは、データベースに対する CREATE、INSERT、DROP、および SELECT 権限が付与されていなければなりません。ユーザー権限の詳細については、MySQLモードの権限分類を参照してください。

• $user_name：テナントへの接続アカウントです。ODP経由で接続する場合の一般的な形式はユーザー名@テナント名#クラスタ名またはクラスタ名:テナント名:ユーザー名。直接接続の場合はユーザー名@テナント名となります。

• $password：アカウントのパスワードです。

接続文字列の詳細については、OBClientを使用してOceanBaseテナントに接続するを参照してください。

ステップ2：OceanBase MCP Serverを設定する

OceanBase MCP Serverリポジトリのクローン

下記のコマンドを実行して、ソースコードをローカルにダウンロードします。

git clone https://github.com/oceanbase/mcp-oceanbase.git

ソースコードのディレクトリに移動します。

cd mcp-oceanbase

依存関係のインストール

mcp-oceanbaseディレクトリで下記のコマンドを実行して仮想環境を作成し、依存関係をインストールします。

uv venv
source .venv/bin/activate
uv pip install .

Traeクライアントの作業ディレクトリを作成

Traeの作業ディレクトリを手動で作成し、Traeで開きます。今後Traeが生成するファイルはこのディレクトリに配置されます。

TraeクライアントでOceanBase MCP Serverを設定

ショートカットキーCtrl + U (Windows)またはCommand + U (MacOS)を使用してチャットダイアログを開き、右上の歯車アイコンをクリックしてMCPを選択します。

MCP Serversの追加と設定

1. MCP Serversを追加をクリックし、手動で設定を選択します。

2. 設定ファイルに情報を入力します。まず編集ボックス内のサンプル内容を削除してください。

   その後、以下の内容を入力します。

   {
     "mcpServers": {
       "oceanbase": {
         "command": "uv",
         "args": [
           "--directory", 
           // mcp-oceanbaseフォルダの絶対パスに置き換える必要があります
           "/path/to/your/mcp-oceanbase/src/oceanbase_mcp_server",
           "run",
           "oceanbase_mcp_server"
         ],
         "env": {
           // ご利用のOceanBaseデータベースの接続情報に置き換える必要があります
           "OB_HOST": "***",
           "OB_PORT": "***",
           "OB_USER": "***",
           "OB_PASSWORD": "***",
           "OB_DATABASE": "***"
         }
       }
     }
   }
   

3. 設定が成功すると、使用可能のステータスが表示されます。

MCP Serverのテスト

1. Builder with MCPを選択します。

2. 表示されたダイアログボックスに、次のプロンプトを入力します：testデータベースにはいくつのテーブルがありますか？。Traeクライアントが実行予定のSQL文を表示します。内容を確認し、問題がなければ実行ボタンをクリックします。

3. 実行結果として、testデータベース内のすべてのテーブル名が表示されます。これにより、OceanBaseデータベースへの接続が正常に確立されたことを確認できます。

FastAPIを使用してRESTful APIスタイルのプロジェクトを迅速に作成する

FastAPIは、PythonでRESTful APIを迅速に構築できるWebフレームワークです。ここでは、customerテーブルを作成し、テストデータを挿入したうえで、FastAPIプロジェクトを自動生成します。

1. customerテーブルの作成

   ダイアログボックスに次のプロンプトを入力します：customerテーブルを作成してください。主キーはIDで、name、age、telephone、locationの各フィールドを含めてください。SQL文を確認し、問題がなければ実行ボタンをクリックします。

2. テストデータの挿入

   ダイアログボックスに次のプロンプトを入力します：customerテーブルに10件のデータを挿入してください。SQL文を確認し、問題がなければ実行ボタンをクリックします。

   挿入が成功すると、実行結果が表示されます。

3. FastAPIプロジェクトの作成

   ダイアログボックスに次のプロンプトを入力します：FastAPIプロジェクトを作成し、customerテーブルに基づいたRESTful APIを生成してください。SQL文を確認し、問題がなければ実行ボタンをクリックします。

   このステップでは3つのファイルが自動生成されます。AIが生成する内容は完全ではない場合があるため、初めて使用する際はすべて受け入れるを選択し、後からニーズに合わせて修正することを推奨します。

4. 仮想環境の作成と依存関係のインストール

   以下のコマンドを実行し、現在のディレクトリでuvパッケージ管理ツールを使って仮想環境を作成し、依存パッケージをインストールします。

   uv venv
   source .venv/bin/activate
   uv pip install -r requirements.txt
   

5. FastAPIプロジェクトの起動

   以下のコマンドを実行して、FastAPIプロジェクトを起動します。

   uvicorn main:app --reload
   

6. テーブル内のデータの確認

   コマンドラインで以下のコマンドを実行するか、他のリクエストツールを使用して、テーブル内のデータを確認します。

   curl http://127.0.0.1:8000/customers
   

   これにより、追加、削除、変更、検索のためのRESTful APIが正常に生成されたことが確認できます。

   from fastapi import FastAPI
   from pydantic import BaseModel
   import mysql.connector
   
   app = FastAPI()
   
   # データベース接続設定
   config = {
       'user': '*******',
       'password': '******',
       'host': 'xx.xxx.xxx.xx',
       'database': 'test',
       'port':xxxx,
       'raise_on_warnings': True
   }
   
   class Customer(BaseModel):
       id: int
       name: str
       age: int
       telephone: str
       location: str
   
   @app.get('/customers')
   async def get_customers():
       cnx = mysql.connector.connect(**config)
       cursor = cnx.cursor(dictionary=True)
       query = 'SELECT * FROM customer'
       cursor.execute(query)
       results = cursor.fetchall()
       cursor.close()
       cnx.close()
       return results
   
   @app.get('/customers/{customer_id}')
   async def get_customer(customer_id: int):
       cnx = mysql.connector.connect(**config)
       cursor = cnx.cursor(dictionary=True)
       query = 'SELECT * FROM customer WHERE ID = %s'
       cursor.execute(query, (customer_id,))
       result = cursor.fetchone()
       cursor.close()
       cnx.close()
       return result
   
   @app.post('/customers')
   async def create_customer(customer: Customer):
       cnx = mysql.connector.connect(**config)
       cursor = cnx.cursor()
       query = 'INSERT INTO customer (ID, name, age, telephone, location) VALUES (%s, %s, %s, %s, %s)'
       data = (customer.id, customer.name, customer.age, customer.telephone, customer.location)
       cursor.execute(query, data)
       cnx.commit()
       cursor.close()
       cnx.close()
       return {'message': 'Customer created successfully'}
   
   @app.put('/customers/{customer_id}')
   async def update_customer(customer_id: int, customer: Customer):
       cnx = mysql.connector.connect(**config)
       cursor = cnx.cursor()
       query = 'UPDATE customer SET name = %s, age = %s, telephone = %s, location = %s WHERE ID = %s'
       data = (customer.name, customer.age, customer.telephone, customer.location, customer_id)
       cursor.execute(query, data)
       cnx.commit()
       cursor.close()
       cnx.close()
       return {'message': 'Customer updated successfully'}
   
   @app.delete('/customers/{customer_id}')
   async def delete_customer(customer_id: int):
       cnx = mysql.connector.connect(**config)
       cursor = cnx.cursor()
       query = 'DELETE FROM customer WHERE ID = %s'
       cursor.execute(query, (customer_id,))
       cnx.commit()
       cursor.close()
       cnx.close()
       return {'message': 'Customer deleted successfully'}