Database MCP

🚀 データベース MCP サービス

Meteor制御プロトコル (MCP) サービスで、複数のデータベースタイプをサポートし、GORMを通じてデータベース機能を提供します。

✨ 主な機能

• 複数のデータベースタイプをサポート:
  • MySQL
  • PostgreSQL
  • SQLite
  • SQL Server
  • ClickHouse
• 設定方法:
  • 設定ファイル（YAML）
  • コマンドライン引数
  • 環境変数
• MCPプロトコルの統合
• GORM ORMのサポート

📦 インストール

1. リポジトリをクローンします。
2. 依存関係をインストールします。

   go mod tidy
   

📚 ドキュメント

設定ファイル（config.yaml）

config.yaml ファイルを作成し、以下の構造にします。

database:
  type: "mysql"  # mysql, postgres, sqlite, sqlserver, clickhouse
  host: "localhost"
  port: 3306
  username: "root"
  password: "password"
  database: "mydb"
  ssl_mode: "disable"  # for postgres
  file: "database.db"  # for sqlite

コマンドライン引数

コマンドラインで設定ファイルの設定を上書きできます。

./database-mcp --config=config.yaml \
  --db-type=mysql \
  --db-host=localhost \
  --db-port=3306 \
  --db-user=root \
  --db-pass=password \
  --db-name=mydb \
  --db-ssl-mode=disable \
  --db-file=database.db

利用可能なコマンドライン引数は以下の通りです。

• --config：設定ファイルのパス（デフォルト： "config.yaml"）
• --db-type：データベースタイプ（mysql, postgres, sqlite, sqlserver, clickhouse）
• --db-host：データベースのホストアドレス
• --db-port：データベースのポート
• --db-user：データベースのユーザー名
• --db-pass：データベースのパスワード
• --db-name：データベース名
• --db-ssl-mode：SSLモード（PostgreSQL用）
• --db-file：データベースファイルのパス（SQLite用）

💻 使用例

基本的な使用法

1. サービスを起動します。

   ./database-mcp --db-type=mysql --db-host=127.0.0.1 --db-port=3306 --db-user=dbuser --db-pass=passwd --db-name=dbname --db-ssl-mode=disable --mode=http
   

2. サービスの機能:
   • 設定ファイルおよび/またはコマンドライン引数を読み込みます。
   • データベース接続を初期化します。
   • MCPサーバーを起動します。
   • 利用可能なツールとリソースを登録します。

MCP設定

MCPサービスを使用するには、MCPクライアントでMCPエンドポイントを設定します。

http://127.0.0.1:8080/sse

これにより、MCPクライアントがポート8080でローカルで実行されているサービスに接続します。

MCPツール

このサービスは以下のMCPツールを提供します。

1. get_tables：データベース内のすべてのテーブルを取得します。
   • 戻り値：テーブル名とコメントを含むリスト
2. get_table_detail：特定のテーブルの詳細情報を取得します。
   • パラメータ：
     • table_name：詳細情報を取得するテーブル名
   • 戻り値：テーブル名、コメント、列情報（フィールド名、型、コメント、NULL許容、デフォルト値）などの情報
3. execute_sql：SQLクエリを実行します。
   • パラメータ：
     • query：実行するSQLクエリ文
   • 戻り値：
     • SELECTクエリの場合：結果データの配列
     • その他のクエリ（INSERT、UPDATE、DELETEなど）の場合：影響を受けた行数

📄 ライセンス

MIT License