Postgresql MCP

🚀 PostgreSQL MCP サーバー

PostgreSQL データベースのテーブルに対する作成、読み取り、更新、削除（CRUD）操作を提供するモデルコンテキストプロトコル（MCP）サーバーです。

🚀 クイックスタート

この MCP サーバーを使用すると、一連のツールを通じて PostgreSQL データベースとやり取りし、指定されたテーブルに対する CRUD 操作を実行できます。サーバーは FastMCP ライブラリを使用し、標準入出力モードで動作するため、さまざまな MCP クライアントと互換性があります。

✨ 主な機能

• PostgreSQL データベースへの接続
• 指定されたテーブルに対する CRUD 操作の実行
• テーブルレベルと列レベルのアクセス制御
• データベーステーブル構造のチェック
• カスタム SQL クエリの実行
• YAML ファイルによる設定

📦 インストール

1. このリポジトリをクローンします：

   git clone https://github.com/yourusername/postgresql-mcp.git
   cd postgresql-mcp
   

2. 必要な依存関係をインストールします：

   pip install -r requirements.txt
   

📚 ドキュメント

設定

サーバーは config.yaml ファイルを通じて設定されます。このファイルには以下が含まれます：

1. データベース接続の詳細情報
2. テーブル設定：
   • アクセス可能なテーブル
   • 操作が許可されている列
   • 許可されている操作（作成、読み取り、更新、削除）

設定例：

database:
  host: localhost
  port: 5432
  dbname: postgres
  user: postgres
  password: postgres
  
tables:
  - name: users
    allowed_columns:
      - id
      - name
      - email
      - created_at
    allowed_operations:
      - create
      - read
      - update
      - delete
  
  - name: products
    allowed_columns:
      - id
      - name
      - price
      - description
      - category
    allowed_operations:
      - create
      - read
      - update
      - delete

使用方法

MCP サーバーを起動します：

python postgresql_mcp_server.py

サーバーは標準入出力モードで起動し、MCP クライアントからのコマンドを受け取る準備ができます。

利用可能な MCP ツール

基本的な使用法

list_tables

設定されたすべてのテーブルをリストします。

response = list_tables()

create_record

指定されたテーブルに新しいレコードを作成します。

response = create_record(
    table_name="users",
    data={
        "name": "John Doe",
        "email": "john@example.com"
    }
)

read_records

指定されたテーブルからレコードを読み取り、オプションのフィルタ条件を指定できます。

response = read_records(
    table_name="users",
    filters={"name": "John Doe"},
    limit=10,
    offset=0
)

update_record

指定されたテーブルのレコードを更新します。

response = update_record(
    table_name="users",
    record_id=1,
    data={"email": "newemail@example.com"},
    id_column="id"
)

delete_record

指定されたテーブルからレコードを削除します。

response = delete_record(
    table_name="users",
    record_id=1,
    id_column="id"
)

execute_query

カスタム SQL クエリを実行します。

response = execute_query(
    query="SELECT * FROM users WHERE age > %s",
    params=[18]
)

get_table_schema

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

response = get_table_schema(table_name="users")

応答形式

すべてのツールは標準の応答形式を返します：

{
  "status": "success",
  "message": "Optional message",
  "records": [...],  // 読み取り操作に使用
  "record": {...},   // 作成と更新操作に使用
  "count": 10        // 読み取り操作に使用
}

エラーが発生した場合、応答ステータスは error になり、エラーメッセージが含まれます。

注意事項

⚠️ 重要提示

• データベース接続情報は実際の環境に合わせて設定する必要があります。
• テーブルと列のアクセス制御は設定ファイルの定義に厳密に従います。
• すべての SQL クエリはパラメータ化された方法で実行する必要があり、注入攻撃を防止します。