Postgresql MCP Server Y4k

🚀 PostgreSQL MCP サーバー

このサーバーは、PostgreSQL データベースとのやり取りを行うための Model Context Protocol (MCP) サーバーです。SELECT クエリの実行や、INSERT、UPDATE、DELETE 操作、新規テーブルの作成、データベース内のテーブル情報の取得などの機能を提供します。

🚀 クイックスタート

この PostgreSQL MCP サーバーを使用することで、PostgreSQL データベースとのやり取りを効率的に行うことができます。以下に、サーバーのセットアップと使用方法を説明します。

✨ 主な機能

• 読み取りクエリ：SELECT タイプの SQL クエリを実行します。
• 書き込みクエリ：INSERT、UPDATE、DELETE タイプの SQL 操作を実行します。
• テーブル作成：データベース内に新しいテーブルを作成します。
• テーブル一覧表示：データベース内のすべてのテーブル情報を取得します。

📦 インストール

前提条件

• PostgreSQL データベースインスタンス
• Go 言語開発環境
• Make ツール

リポジトリのクローン

git clone https://github.com/yourusername/pgmcp.git
cd pgmcp

依存関係のインストール

go mod tidy

サーバーのビルド

make build

📚 ドキュメント

設定説明

以下の環境変数をプロジェクトの .env ファイルに追加してください。

• DB_NAME: PostgreSQL データベース名
• DB_USER: データベースに接続するユーザー名
• DB_PASSWORD: ユーザーパスワード
• DB_HOST: データベースのホストアドレス（デフォルトは localhost）
• DB_PORT: データベースのポート番号（デフォルトは 5432）

.env ファイルの例:

DB_NAME=postgres
DB_USER=pguser
DB_PASSWORD=pgpassword
DB_HOST=localhost
DB_PORT=5432

💻 使用例

サーバーの起動

go run main.go

MCP 設定

config.json で MCP サービスのパラメータを設定します。

{
  "name": "PostgreSQL MCP Server",
  "version": "1.0",
  "description": "A PostgreSQL MCP server implementation.",
  "tools": {
    "read_query": {
      "description": "Execute a SELECT query and return the results."
    },
    "write_query": {
      "description": "Execute an INSERT, UPDATE, or DELETE statement."
    },
    "create_table": {
      "description": "Create a new table in the database."
    },
    "list_tables": {
      "description": "List all tables in the database."
    }
  }
}

基本的な使用法

読み取りクエリ

{
  "tool": "read_query",
  "params": {
    "query": "SELECT * FROM users LIMIT 10;"
  }
}

書き込みクエリ

{
  "tool": "write_query",
  "params": {
    "query": "INSERT INTO users (name, email) VALUES ($1, $2);",
    "args": ["John Doe", "john@example.com"]
  }
}

テーブル作成

{
  "tool": "create_table",
  "params": {
    "table_name": "users",
    "schema": "CREATE TABLE users (\n    id SERIAL PRIMARY KEY,\n    name VARCHAR(255) NOT NULL,\n    email VARCHAR(255) UNIQUE NOT NULL\n);"
  }
}

テーブル一覧表示

{
  "tool": "list_tables",
  "params": {}
}

🔧 技術詳細

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

• サーバーはクエリタイプを検証し、各ツールが許可された操作のみを実行するようにします。
• 入力されたスキーマ名をサニタイズし、SQL インジェクション攻撃を防止します。
• 権限が制限された専用のデータベースユーザーを使用することを推奨します。
• 本番環境では SSL を有効にし、DB_SSLMODE を require またはそれ以上に設定します。

依存関係

• github.com/joho/godotenv - .env ファイルを読み込みます。
• github.com/lib/pq - PostgreSQL ドライバーです。
• github.com/mark3labs/mcp-go - MCP プロトコルの Go SDK です。

📄 ライセンス

[ここにライセンス情報を追加]

🔗 貢献ガイド

[ここに貢献ガイドを追加]