Db MCP Server

🚀 データベース管理コンソールサーバー

このデータベース管理コンソールサーバーは、多様なデータベースを管理し、OpenAIのAgents SDKとの統合を可能にし、高可用性を備えたシステムです。多くの便利な機能を提供し、データベース操作を効率的かつ安定的に行うことができます。

✨ 主な機能

• 多データベースサポート：MySQL、PostgreSQLなどの主流データベースをサポートします。
• SSEモード統合：OpenAIのAgents SDKと完全に互換性があり、SSEプロトコルを通じて人工知能エージェントとのやり取りをサポートします。
• クエリタイムアウト設定：各データベース接続に対して個別にクエリタイムアウト時間を設定でき、デフォルトは30秒です。
• 高可用性設計：接続プールと負荷分散機能が組み込まれており、データベース操作の効率と安定性を確保します。

🚀 クイックスタート

サーバーの起動

# コンソールモードで起動
./server -mode=console

# SSEモードで起動（OpenAIエージェント統合用）
./server -mode=sse

基本的な設定ファイルの例

{
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "mysql1",
            "port": 3306,
            "name": "db1",
            "user": "user1",
            "password": "pass1"
        }
    ]
}

💻 使用例

基本的な使用法

# クエリ操作の実行
query mysql1 "SELECT * FROM users LIMIT 10"

# タイムアウト設定付きのクエリ
query mysql1 --timeout=60 "SELECT * FROM large_table"

# テーブル構造の確認
describe mysql1 users

高度な使用法

# 他の高度な操作やシナリオに応じたコマンドを記述することができます。

📚 ドキュメント

コンソール操作コマンド

基本コマンド

• help：利用可能なすべてのコマンドを表示します。
• query：SQLクエリを実行し、タイムアウトパラメータをサポートします。
• describe：テーブル構造情報を表示します。
• execute：DML操作（INSERT、UPDATE、DELETEなど）を実行します。
• schema：データベースのスキーマ情報を取得します。
• connections：データベース接続状態を管理します。

エラー処理

一般的なエラー

• 接続タイムアウト：対象のデータベースサービスが正常に動作しているか確認してください。
• 権限不足：ユーザーが適切なデータベース権限を持っていることを確認してください。
• 構文エラー：SQL文にスペルや構文の問題がないか注意深く確認してください。

ログ記録

サーバーはデフォルトでlogs/ディレクトリにログを出力し、DEBUG、INFO、WARNING、ERRORの4つのログレベルをサポートしています。

OpenAIエージェントSDK統合

互換性の説明

• SSEプロトコルを通じてOpenAIのGPT - 4oなどのモデルとのやり取りをサポートします。
• クエリ、記述、実行機能を含む完全なデータベースツールチェーンを提供します。

基本的な統合例

from openai import OpenAI
from agents.agent import Agent, ModelSettings
from agents.tools.mcp_server import MCPServerSse, MCPServerSseParams

# MCPサーバー接続の初期化
db_server = MCPServerSse(
    params=MCPServerSseParams(
        url="http://localhost:9095/sse"
    ),
)

# データベース操作機能を持つエージェントの作成
agent = Agent(
    name="Database Assistant",
    model="gpt-4o",
    model_settings=ModelSettings(temperature=0.1),
    instructions="""
    あなたは専門のデータベースアシスタントで、SQLクエリの実行、トランザクションの管理、テーブル構造の分析ができます。
    """,
    tools=[db_server]
)

データベース接続プールの設定

{
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "mysql1",
            "port": 3306,
            "name": "db1",
            "user": "user1",
            "password": "pass1",
            "pool_size": 5,
            "max_idle_time": 60
        }
    ]
}

テーブル出力形式

文献記録

すべてのドキュメントと設計思想はプロジェクトリポジトリで確認できます。

⚠️ 重要提示

このツールを使用する前に、関連するセキュリティ注意事項を読み、理解することを確認してください。特に本番環境で使用する場合は、細心の注意を払ってください。