MCP Postgres Server

🚀 MCP PostgreSQL サーバー

PostgreSQL データベース操作を提供するモデルコンテキストプロトコル（MCP）サーバーです。このサーバーにより、AI モデルは標準化されたインターフェースを通じて PostgreSQL データベースとやり取りすることができます。

🚀 クイックスタート

このサーバーを使用することで、AI モデルは簡単に PostgreSQL データベースとやり取りできます。以下に、インストール方法や使用可能なツールについて説明します。

📦 インストール

手動インストール

npm install mcp-postgres-server

または、直接実行することもできます：

npx mcp-postgres-server

📚 ドキュメント

設定

サーバーには以下の環境変数が必要です：

{
  "mcpServers": {
    "postgres": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "mcp-postgres-server"],
      "env": {
        "PG_HOST": "your_host",
        "PG_PORT": "5432",
        "PG_USER": "your_user",
        "PG_PASSWORD": "your_password",
        "PG_DATABASE": "your_database"
      }
    }
  }
}

利用可能なツール

1. connect_db

提供された資格情報を使用して、PostgreSQL データベースへの接続を確立します。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "connect_db",
  arguments: {
    host: "localhost",
    port: 5432,
    user: "your_user",
    password: "your_password",
    database: "your_database"
  }
});

2. query

SELECT クエリを実行し、オプションのプリペアドステートメントパラメータをサポートします。PostgreSQL 形式（$1, $2）と MySQL 形式 (?) のパラメータプレースホルダーをサポートします。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "query",
  arguments: {
    sql: "SELECT * FROM users WHERE id = $1",
    params: [1]
  }
});

3. execute

INSERT、UPDATE、または DELETE クエリを実行し、オプションのプリペアドステートメントパラメータをサポートします。PostgreSQL 形式（$1, $2）と MySQL 形式 (?) のパラメータプレースホルダーをサポートします。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "execute",
  arguments: {
    sql: "INSERT INTO users (name, email) VALUES ($1, $2)",
    params: ["John Doe", "john@example.com"]
  }
});

4. list_schemas

データベース内のすべてのスキーマをリストします。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_schemas",
  arguments: {}
});

5. list_tables

データベース内のテーブルをリストします。オプションのスキーマパラメータ（デフォルトは 'public'）を受け付けます。

// 'public' スキーマ内のテーブルをリストする（デフォルト）
use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_tables",
  arguments: {}
});

// 特定のスキーマ内のテーブルをリストする
use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_tables",
  arguments: {
    schema: "my_schema"
  }
});

6. describe_table

特定のテーブルの構造を取得します。オプションのスキーマパラメータ（デフォルトは 'public'）を受け付けます。

// 'public' スキーマ内のテーブルを説明する（デフォルト）
use_mcp_tool({
  server_name: "postgres",
  tool_name: "describe_table",
  arguments: {
    table: "users"
  }
});

// 特定のスキーマ内のテーブルを説明する
use_mcp_tool({
  server_name: "postgres",
  tool_name: "describe_table",
  arguments: {
    table: "users",
    schema: "my_schema"
  }
});

✨ 主な機能

• 自動クリーンアップ機能付きの安全な接続処理
• SQL インジェクションを防止するためのプリペアドステートメントのサポート
• PostgreSQL 形式（$1, $2）と MySQL 形式 (?) のパラメータプレースホルダーのサポート
• 包括的なエラー処理と検証
• TypeScript のサポート
• 自動化された接続管理
• PostgreSQL 固有の構文と機能のサポート
• マルチスキーマのサポート

🔒 セキュリティ

• プリペアドステートメントを使用した SQL インジェクションの防止
• 環境変数を通じたパスワードなどの機密情報の安全な保存のサポート
• 強化された認証メカニズム

🔧 エラー処理

• 明確なエラー返却メカニズム
• 詳細なエラーログ記録
• カスタマイズ可能なエラー処理ロジック

📄 ライセンス