Postgres Mysql MCP Server

🚀 MCP SQL Server

Model Context Protocol (MCP) サーバーで、PostgreSQL と MySQL データベースをクエリできます。

🚀 クイックスタート

推奨: インストールせずに npx を使用して実行します。

npx postgres-mysql-mcp-server

MCP クライアント（Cursor、Windsurf など）の設定には、以下を使用します。

{
  "mcpServers": {
    "sql": {
      "command": "npx",
      "args": ["-y", "postgres-mysql-mcp-server"],
      "env": {
        "DB_TYPE": "postgresql",
        "DB_HOST": "localhost",
        "DB_PORT": "5432",
        "DB_DATABASE": "mydb",
        "DB_USER": "postgres",
        "DB_PASSWORD": "password"
      }
    }
  }
}

✨ 主な機能

MCPとは、なぜ使用するのか？

Model Context Protocol (MCP) は、Cursor や Windsurf などのコードエディターや、その他のAI搭載開発ツール内のAIアシスタントが、外部システムやデータソースと安全にやり取りできるようにする標準化されたプロトコルです。

このMCPサーバーは、AIコーディングアシスタントとデータベース間のギャップを埋め、AIが以下のことができるようにします。

• データベーススキーマを理解する - AIはテーブル、列、関係を探索できます。
• 正確なSQLクエリを作成する - 実際のデータベース構造に基づいてクエリを生成します。
• データベースの問題をデバッグする - データをクエリして問題を理解し、修正を検証します。
• データベースを意識したコードを生成する - データベーススキーマに合ったアプリケーションコードを作成します。
• データに関する質問に答える - データベースをクエリして正確な情報を提供します。

AI搭載エディターに最適

Cursor や Windsurf などのAIエディターと統合すると、このMCPサーバーはAIアシスタントをデータベースを意識したコーディングコンパニオンに変えます。

使用例:

1. スキーマを意識したコード生成

   • あなた: "ユーザー登録APIエンドポイントを作成して"
   • AI: 自動的にデータベーススキーマをクエリし、users テーブルの構造を理解し、正確な列名と型に合ったコードを生成します。

2. インテリジェントなクエリ作成

   • あなた: "過去30日間のすべてのアクティブユーザーを表示して"
   • AI: データベースに接続し、スキーマを確認し、実際のテーブルと列名を使用して正しいSQLクエリを作成します。

3. データベースのデバッグ

   • あなた: "ユーザーログインが失敗するのはなぜか"
   • AI: データベースをクエリしてユーザーレコードを確認し、テーブル構造を検証し、潜在的な問題を特定します。

4. データ駆動開発

   • あなた: "ユーザー統計を表示するダッシュボードを作成して"
   • AI: データベーススキーマを探索し、関係を理解し、正確なクエリとコードを生成します。

5. 移行とリファクタリング

   • あなた: "このコードを新しいデータベーススキーマに合わせてリファクタリングして"
   • AI: コードと実際のデータベーススキーマを比較し、正確な変更を提案します。

仕組み

1. AIエディター（Cursor、Windsurfなど）でMCPサーバーを設定します。
2. PostgreSQLまたはMySQLデータベースに接続します。
3. AIアシスタントに質問をしたり、コード生成を要求します。
4. AIはMCPサーバーを使用してデータベーススキーマとデータをクエリします。
5. 正確な、データベースを意識した応答とコードを取得します。

AIアシスタントは、データベース構造とデータを「見る」ことができるため、データベース関連のコードを生成する際にはるかに役立ち、正確になります。

その他の機能

• PostgreSQL と MySQL データベースに接続できます。
• SQL クエリを実行できます。
• データベースのテーブルを一覧表示できます。
• テーブルのスキーマを説明できます。
• パラメータ化されたクエリをサポートしています。
• パフォーマンス向上のためのコネクションプーリングがあります。
• 環境変数を使用した安全な資格情報管理が可能です。
• 環境変数が設定されている場合、起動時に自動的に接続します。

📦 インストール

オプション1: npxを使用する（推奨 - インストール不要）

推奨: インストールせずに npx でサーバーを直接実行します。これが最も簡単で便利な方法です。

npx postgres-mysql-mcp-server

-y フラグは npx によって自動的に処理されるため、最新バージョンがプロンプトなしでダウンロードされて実行されます。

オプション2: npmを通じてインストールする

パッケージをインストールする場合は、以下の方法があります。

グローバルインストール:

npm install -g postgres-mysql-mcp-server

プロジェクト内にローカルインストール:

npm install postgres-mysql-mcp-server

オプション3: 開発用インストール

ローカル開発またはコントリビューション用には、以下の手順を実行します。

git clone https://github.com/TranChiHuu/postgres-mysql-mcp-server.git
cd postgres-mysql-mcp-server
npm install

💻 使用例

サーバーの実行

サーバーは標準入出力で動作し、MCPプロトコルを通じて通信します。

推奨: npxを使用する（インストール不要）

npx postgres-mysql-mcp-server

これがサーバーを実行する推奨方法です。npxは自動的に最新バージョンをダウンロードして実行します。

代替: グローバルにインストールされたパッケージを使用する

postgres-mysql-mcp-server

ローカル開発用:

npm start

利用可能なツール

1. connect_database

PostgreSQLまたはMySQLデータベースに接続します。パラメータは直接指定するか、環境変数から読み込むか、またはその両方の組み合わせで指定できます。環境変数が設定されている場合、サーバーは起動時に自動的に接続します。

パラメータ（環境変数を使用する場合はすべてオプション）:

• type (文字列, オプション): データベースの種類 - "postgresql" または "mysql"
• host (文字列, オプション): データベースのホスト
• port (数値, オプション): データベースのポート
• database (文字列, オプション): データベース名
• user (文字列, オプション): データベースのユーザー
• password (文字列, オプション): データベースのパスワード
• ssl (ブール値, オプション): SSL接続を使用する（デフォルト: false）

例:

パラメータを使用する場合:

{
  "type": "postgresql",
  "host": "localhost",
  "port": 5432,
  "database": "mydb",
  "user": "postgres",
  "password": "password"
}

環境変数を使用する場合（パラメータなしで呼び出す）:

{}

パラメータと環境変数を混合する場合:

{
  "type": "postgresql",
  "host": "custom-host"
}

2. execute_query

接続されたデータベースでSQLクエリを実行します。

パラメータ:

• query (文字列, 必須): 実行するSQLクエリ
• params (配列, オプション): パラメータ化されたクエリのパラメータ

例:

{
  "query": "SELECT * FROM users WHERE id = $1",
  "params": [123]
}

3. list_tables

接続されたデータベース内のすべてのテーブルを一覧表示します。

パラメータ: なし

4. describe_table

特定のテーブルのスキーマ情報を取得します。

パラメータ:

• tableName (文字列, 必須): 説明するテーブルの名前

例:

{
  "tableName": "users"
}

5. disconnect_database

現在のデータベースから切断します。

パラメータ: なし

📚 ドキュメント

環境変数

環境変数を使用してデータベース接続を構成できます。プロジェクトのルートに .env ファイルを作成するか、環境変数を設定します。

オプション1: 汎用環境変数（PostgreSQLとMySQLの両方で動作）

DB_TYPE=postgresql          # または "mysql"
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=mydb
DB_USER=postgres
DB_PASSWORD=password
DB_SSL=false               # オプション、SSLを使用する場合は "true" に設定

オプション2: PostgreSQL固有の環境変数

POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_DATABASE=mydb
POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
POSTGRES_SSL=false         # オプション

オプション3: MySQL固有の環境変数

MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DATABASE=mydb
MYSQL_USER=root
MYSQL_PASSWORD=password
MYSQL_SSL=false            # オプション

注意: 環境変数が設定されている場合、サーバーは起動時に自動的に接続します。また、connect_database をパラメータなしで呼び出して環境変数を使用するか、環境変数とマージされる部分的なパラメータを提供することもできます。

MCPクライアントの設定

このMCPサーバーは、AI搭載のコードエディターとシームレスに統合されます。データベースを意識したAIアシスタントを有効にするには、MCPクライアントの設定に追加します。

サポートされているエディター

• Cursor - AI搭載のコードエディター
• Windsurf - AIを第一に考慮したIDE
• Model Context Protocolをサポートする任意のエディター

設定手順

Cursorの場合:

1. Cursorの設定を開きます。
2. 機能 → Model Context Protocolに移動します。
3. 以下のサーバー設定を追加します。

Windsurfの場合:

1. 設定を開きます。
2. MCPサーバーに移動します。
3. 以下のサーバー設定を追加します。

その他のMCP互換エディターの場合: MCP設定ファイル（通常は ~/.config/mcp/settings.json またはエディター固有の場所）に設定を追加します。

設定オプション

オプション1: npxを使用する（推奨 - インストール不要）

これが推奨される設定です。npxはインストールを必要とせずに最新バージョンを自動的にダウンロードして実行します。

{
  "mcpServers": {
    "sql": {
      "command": "npx",
      "args": ["-y", "postgres-mysql-mcp-server"],
      "env": {
        "DB_TYPE": "postgresql",
        "DB_HOST": "localhost",
        "DB_PORT": "5432",
        "DB_DATABASE": "mydb",
        "DB_USER": "postgres",
        "DB_PASSWORD": "password"
      }
    }
  }
}

npxを使用する利点:

• ✅ インストール不要
• ✅ 常に最新バージョンを使用
• ✅ 手動での更新不要
• ✅ 異なるプロジェクト間で競合せずに動作
• ✅ -y フラグにより、インストールプロンプトに自動的に "yes" と回答

オプション2: グローバルにインストールされたパッケージを使用する

パッケージをグローバルにインストールした場合 (npm install -g postgres-mysql-mcp-server) :

{
  "mcpServers": {
    "sql": {
      "command": "postgres-mysql-mcp-server",
      "env": {
        "DB_TYPE": "postgresql",
        "DB_HOST": "localhost",
        "DB_PORT": "5432",
        "DB_DATABASE": "mydb",
        "DB_USER": "postgres",
        "DB_PASSWORD": "password"
      }
    }
  }
}

オプション3: ローカルインストールを使用する

パッケージをプロジェクト内にローカルにインストールした場合 (npm install postgres-mysql-mcp-server) :

{
  "mcpServers": {
    "sql": {
      "command": "node",
      "args": ["./node_modules/postgres-mysql-mcp-server/index.js"],
      "env": {
        "DB_TYPE": "postgresql",
        "DB_HOST": "localhost",
        "DB_PORT": "5432",
        "DB_DATABASE": "mydb",
        "DB_USER": "postgres",
        "DB_PASSWORD": "password"
      }
    }
  }
}

オプション4: 開発用セットアップ（ローカル開発用）

ローカルで開発し、リポジトリをクローンした場合:

{
  "mcpServers": {
    "sql": {
      "command": "npm",
      "args": ["start"],
      "cwd": "/path-to-source/postgres-mysql-mcp-server",
      "env": {
        "DB_TYPE": "postgresql",
        "DB_HOST": "localhost",
        "DB_PORT": "5432",
        "DB_DATABASE": "mydb",
        "DB_USER": "postgres",
        "DB_PASSWORD": "password"
      }
    }
  }
}

例: Cursor AIと一緒に使用する

設定が完了すると、自然言語でデータベースと対話できます。

会話の例:

あなた: "私のデータベースにはどのようなテーブルがありますか？"
AI: [list_tablesツールを使用] "あなたのデータベースには、以下のテーブルが含まれています: users, orders, products, categories"

あなた: "usersテーブルの構造を教えてください"
AI: [describe_tableツールを使用] "usersテーブルには、以下の列があります: id (整数), email (文字列), created_at (タイムスタンプ)..."

あなた: "ユーザーIDでユーザーを取得するAPIエンドポイントを作成して"
AI: [describe_tableを使用してスキーマを理解し、コードを生成]
     "これがあなたのusersテーブルの構造に合ったエンドポイントです..."

AIアシスタントは、適切なMCPツールを自動的に使用してデータベースをクエリし、正確な、スキーマを意識した応答を提供します。

開発について

このプロジェクトは、プレーンなJavaScript（ESモジュール）を使用しているため、ビルドステップは必要ありません。index.js を編集して npm start を実行するだけです。

セキュリティに関する注意事項

• データベースの資格情報をバージョン管理システムにコミットしないでください。
• 環境変数または安全な資格情報管理を使用してください。
• サーバーは、安全なデータベースアクセスのためにSSL接続をサポートしています。
• 本番環境では、常にSQLクエリを検証してサニタイズしてください。

必要条件

• Node.js 18以上
• PostgreSQLまたはMySQLデータベースへのアクセス

コントリビューション

コントリビューションは大歓迎です！プルリクエストを自由に送信してください。

📄 ライセンス

MIT