OceanBase MCP ServerとAugment Codeの連携

MCP（Model Context Protocol）は、Anthropic社が2024年11月に発表し、オープンソース化したプロトコルです。大規模言語モデルと外部ツールやデータソースとの連携を実現することを目的としています。MCPを利用することで、ユーザーは大規模言語モデルの出力を手動でコピーして実行する必要がなく、モデルが直接ツールに指示を出して対応するアクションを実行させることができます。

OceanBase MCP Serverは、MCPプロトコルを通じて大規模言語モデルとOceanBaseデータベースとの連携を提供し、SQL文を実行できるようにします。適切なクライアントを利用することでプロジェクトのプロトタイプを迅速に構築でき、GitHub上でオープンソースとして公開されています。

Augment Codeは、開発者向けのAIプラットフォームであり、コードの理解、問題のデバッグ、そしてコードベースを理解しているためより迅速なリリースを支援します。チャット、次の編集、コード補完を活用して、より多くの作業を効率的に進めることができます。

本記事では、Augment Codeを使用し、OceanBase MCP Serverを通じてバックエンドアプリケーションを迅速に構築する方法を紹介します。

前提条件

• 環境に利用可能なトランザクション型(MySQL)クラスタインスタンスがあります。

テナントの作成を参照してテナントの作成を完了した後、以下の手順を実行します。

• 環境に使用可能なMySQL互換モードのテナントとMySQLデータベースおよびアカウントが既に存在し、データベースアカウントに読み書き権限が付与されています。作成が必要な場合は、詳細についてはアカウントの作成およびデータベースの作成(MySQL専用)をご参照ください。

• プロジェクト管理者またはインスタンス管理者ロールを持ち、プロジェクト内のインスタンスに対する読み書き操作を実行できます。権限がない場合は、組織管理者に連絡して権限の追加を依頼してください。

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

• 使用しているOSに応じて、Gitをインストールします。ご自身のOSに合わせて、ダウンロードしてインストールしてください：

  • Windows：https://git-scm.com/downloads/win。

  • macOS：https://git-scm.com/download/mac。

  • Linux：https://git-scm.com/downloads/linux。

• Pythonパッケージマネージャuvをインストールします。

  • macOS/Linuxでは、独立したスクリプトを使用してインストールできます：

    curl -LsSf https://astral.sh/uv/install.sh | sh
    

  • Windowsプラットフォームでは、以下のスクリプトを使用します：

    irm https://astral.sh/uv/install.ps1 | iex
    

  • または、プラットフォームに依存しないpipインストール方法を使用することもできます：

    pip install uv
    

• インストールが完了したら、uv --version コマンドを使用してインストールが成功したかどうか確認できます：

  pip install uv
  uv --version
  

• Augment Codeのインストール：

  1. VS Codeを開きます(なければ、公式ドキュメントを参照してインストールしてください)。

  2. サイドバーの拡張機能アイコンをクリックします。

  3. “Augment Code”と検索してインストールをクリックします。

  4. Augment Codeアカウントに登録してログインします。

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

1. ドロップダウンリストから、IDに基づいて対象のクラスタインスタンスを選択します。

2. 概要 ページに移動します。

3. 接続をクリックし、接続文字列を取得 を選択します。

4. ポップアップウィンドウで、パブリックネットワークを使用 を選択します。

5. アクセスアドレスを取得し、現在のブラウザIPアドレスを追加 を選択します。

6. データベース関連情報を入力し、**接続文字列をコピー**します。

ステップ2：OceanBase MCP Serverの設定

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

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

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

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

cd awesome-oceanbase-mcp

依存関係のインストール

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

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

MCP Serverの追加と設定

1. Augment CodeでOceanBase MCP Serverを設定します。

   

2. Import from jsonをクリックし、MCP設定ファイルに入力します。

   

   

3. 設定ファイルに入力し、確認をクリックします。

   /path/to/your/oceanbase_mcp_server は oceanbase_mcp_server フォルダの絶対パスに、OB_HOST、OB_PORT、OB_USER、OB_PASSWORD、OB_DATABASE はご自身のデータベースの対応する情報に置き換えてください：

   {
   "mcpServers": {
   "oceanbase": {
     "command": "uv",
     "args": [
       "--directory", 
       "/path/to/your/oceanbase_mcp_server/src/oceanbase_mcp_server",
       "run",
       "oceanbase_mcp_server"
     ],
     "env": {
       "OB_HOST": "***",
       "OB_PORT": "***",
       "OB_USER": "***",
       "OB_PASSWORD": "***",
       "OB_DATABASE": "***"
      }
     }
    }
   }
   

4. データベースへの接続が可能かどうかを検証します。

   「test データベースにはいくつのテーブルがありますか」というプロンプトを入力します：

   Augment Codeは、現在のtestデータベース内のテーブル数を表示します。これにより、OceanBaseデータベースへの接続が正常であることが確認できます。

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

FastAPIは、PythonでRESTful APIを迅速に構築できるWebフレームワークです。

1. テーブルを作成します。

   「customerテーブルを作成してください。主キーはIDで、name、age、telephone、locationの各フィールドを含めてください」というプロンプトを入力します。

2. テストデータを挿入します。

   「10件のテストデータを挿入してください」というプロンプトを入力します。

3. FastAPIプロジェクトを作成します。

   「FastAPIプロジェクトを作成し、customerテーブルに基づいたRESTful APIを生成してください」というプロンプトを入力すると、複数のファイルが自動生成され、コードが修正され、FastAPIプロジェクトが起動します。

4. テーブル内のデータを確認します。

   コマンドラインで curl http://127.0.0.1:8000/customers を実行するか、別のリクエストツールを使用してテーブルのデータを確認します。

   curl http://127.0.0.1:8000/customers
   [{"name":"Zhang San","age":28,"telephone":"13812345678","location":"Chaoyang District, Beijing","id":1},{"name":"Li Si","age":35,"telephone":"13987654321","location":"Pudong New Area, Shanghai","id":2},{"name":"Wang Wu","age":42,"telephone":"15612345678","location":"Tianhe District, Guangzhou","id":3},{"name":"Zhao Liu","age":29,"telephone":"18712345678","location":"Nanshan District, Shenzhen","id":4},{"name":"Qian Qi","age":33,"telephone":"13512345678","location":"Xihu District, Hangzhou","id":5},{"name":"Sun Ba","age":26,"telephone":"15987654321","location":"Jinjiang District, Chengdu","id":6},{"name":"Zhou Jiu","age":38,"telephone":"18612345678","location":"Jianghan District, Wuhan","id":7},{"name":"Wu Shi","age":31,"telephone":"13712345678","location":"Gulou District, Nanjing","id":8},{"name":"Zheng Shi Yi","age":45,"telephone":"15812345678","location":"Yanta District, Xi'an","id":9},{"name":"Wang Shier","age":27,"telephone":"18512345678","location":"Yuzhong District, Chongqing","id":10},{"name":"Test User","age":25,"telephone":"13900000000","location":"Test Address","id":11}]
   

5. 追加、削除、変更、検索のコードがすべて生成されています。

   from sqlalchemy.orm import Session
   from database import Customer
   from schemas import CustomerCreate, CustomerUpdate
   from typing import List, Optional
   
   def get_customer(db: Session, customer_id: int) -> Optional[Customer]:
    """IDに基づいて単一の顧客を取得します"""
    return db.query(Customer).filter(Customer.id == customer_id).first()
   
   def get_customers(db: Session, skip: int = 0, limit: int = 100) -> List[Customer]:
    """顧客リストを取得します"""
    return db.query(Customer).offset(skip).limit(limit).all()
   
   def create_customer(db: Session, customer: CustomerCreate) -> Customer:
    """新規顧客を作成します"""
    db_customer = Customer(**customer.dict())
    db.add(db_customer)
    db.commit()
    db.refresh(db_customer)
    return db_customer
   
   def update_customer(db: Session, customer_id: int, customer: CustomerUpdate) -> Optional[Customer]:
    """顧客情報を更新します"""
    db_customer = db.query(Customer).filter(Customer.id == customer_id).first()
    if db_customer:
        update_data = customer.dict(exclude_unset=True)
        for field, value in update_data.items():
            setattr(db_customer, field, value)
        db.commit()
        db.refresh(db_customer)
    return db_customer
   
   def delete_customer(db: Session, customer_id: int) -> bool:
    """顧客を削除します"""
    db_customer = db.query(Customer).filter(Customer.id == customer_id).first()
    if db_customer:
        db.delete(db_customer)
        db.commit()
        return True
    return False
   
   def search_customers_by_name(db: Session, name: str) -> List[Customer]:
    """氏名で顧客を検索します"""
    return db.query(Customer).filter(Customer.name.contains(name)).all()
   
   def get_customers_by_location(db: Session, location: str) -> List[Customer]:
    """住所で顧客を取得します"""
    return db.query(Customer).filter(Customer.location.contains(location)).all()