MCP Server for PostgreSQL

PostgreSQL用MCPサーバー

PostgreSQL 用のモデル コンテキスト プロトコル (MCP) サーバー実装。MCP を介して PostgreSQL データベースと対話するためのシンプルなインターフェイスを提供します。

特徴

• パラメータ化された入力でSQLクエリを実行する
• INSERT/UPDATE/DELETE操作を実行する
• 新しいデータベースを作成する
• テーブルスキーマの作成または更新
• PostgreSQL接続のデバッグ
• Dockerでコンテナ化して簡単に導入できる
• 環境ベースの構成

前提条件

• Python 3.8以上
• PostgreSQL 10以上
• Docker (オプション、コンテナ化されたデプロイメント用)
• Docker Compose（オプション、開発用）

インストール

Dockerの使用（推奨）

1. リポジトリをクローンします。
   git clone https://github.com/asadudin/mcp-server-postgres.git cd mcp-server-postgres
2. サンプル環境ファイルをコピーします。
   cp .env.example .env
3. PostgreSQL の資格情報を使用して.envファイルを更新します。
   PG_HOST=postgres PG_PORT=5432 PG_USER=postgres PG_PASSWORD=your_password PG_DATABASE=your_database HOST=0.0.0.0 PORT=8056
4. Docker Compose を使用してサービスを開始します。
   docker-compose up -d

手動インストール

1. リポジトリをクローンします。
   git clone https://github.com/asadudin/mcp-server-postgres.git cd mcp-server-postgres
2. 仮想環境を作成してアクティブ化します。
   python -m venv venv source venv/bin/activate # On Windows: .\venv\Scripts\activate
3. 依存関係をインストールします:
   pip install -r requirements.txt
4. サンプル環境ファイルをコピーして更新します。
   cp .env.example .env # Edit .env with your configuration
5. サーバーを実行します。
   python mcp_server_postgres.py

使用法

MCP サーバーは次のエンドポイントを提供します。

sql_query

SELECT クエリを実行し、結果を JSON として返します。

パラメータ:

• query : SQLクエリ文字列
• params : クエリパラメータのオプションのJSON文字列（リストまたは辞書）

例：

sql_execute

INSERT/UPDATE/DELETE ステートメントを実行します。

パラメータ:

• query : SQL文
• params : クエリパラメータのオプションのJSON文字列（リストまたは辞書）

例：

create_database

新しい PostgreSQL データベースを作成します。

パラメータ:

• database_name : 作成するデータベースの名前

create_or_update_table

テーブル スキーマを作成または更新します。

パラメータ:

• sql : CREATE TABLE または ALTER TABLE SQL ステートメント

debug_postgres_connection

PostgreSQL 接続をデバッグします。

環境変数

発達

テストの実行

Dockerイメージの構築

APIドキュメント

詳細な API ドキュメントについては、 OpenAPI 仕様を参照してください。

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細についてはLICENSEファイルを参照してください。

謝辞

• FastMCP - MCP サーバーフレームワーク
• asyncpg - Python 用 PostgreSQL クライアント
• FastAPI - API を構築するための最新の高速 Web フレームワーク