Pg MCP Server

🚀 PostgreSQL MCP サーバーガイド

PostgreSQL MCP サーバーは、PostgreSQL データベースの接続管理、トランザクション制御、クエリ実行などの機能を提供するサーバーです。このガイドでは、このサーバーの使い方や設定方法を詳しく説明します。

📚 目次

• 📦 ディレクトリ構造
• 🧾 核心スクリプトの説明
• 💻 MCP プロトコルの実装
• ⚙️ 環境変数の設定
• 🔒 セキュリティに関する注意事項
• 💡 サンプルの使用シーン
• 📌 注意事項
• 📎 付録

📦 ディレクトリ構造

プロジェクトの構造は以下の通りです。

• dist: コンパイル後の JavaScript ファイルを格納します。
• src: コアライブラリファイルがあります。
• package.json: 依存関係の管理とビルドスクリプトの設定を行います。
• tsconfig.json: TypeScript のコンパイル設定です。

🧾 核心スクリプトの説明

目的と機能

これらのスクリプトは、PostgreSQL データベースの接続の初期化と管理、トランザクションの処理、およびデータベース操作インターフェースの提供を担当しています。

主要なスクリプト

index.ts

• 役割: MCP サーバーを初期化します。
• 機能:
  • コマンドライン引数を解析します。
  • PostgreSQL データベースに接続します。
  • 監視スレッドを起動します。
  • クライアントのリクエストを処理します。

connection-pool.ts

• 役割: データベース接続プールを管理します。
• 機能:
  • データベース接続プールを作成および管理します。
  • 接続の再利用メカニズムを実装します。
  • 接続のタイムアウトパラメータを設定します。
  • 接続の状態を監視します。

transaction-monitor.ts

• 役割: トランザクションの実行状態を監視します。
• 機能:
  • トランザクションの開始時間を記録します。
  • トランザクションのタイムアウト状況をチェックします。
  • 長時間未コミットのトランザクションを自動的にロールバックします。
  • トランザクションの統計情報を提供します。

💻 MCP プロトコルの実装

使用例

const { McpServer } = require('./dist/mcp-server');

// MCP サーバーを初期化します。
const server = new McpServer({
  connectionString: 'postgresql://ユーザー名:パスワード@データベースアドレス:ポート/データベース名',
  transactionTimeoutMs: 15000,
  maxConnections: 20
});

// サーバーを起動します。
server.start();

機能モジュール

• 接続管理: 高い並行アクセスをサポートする効率的なデータベース接続プールを提供します。
• トランザクション制御: トランザクションのコミット、ロールバック機能を実装し、タイムアウト保護メカニズムを提供します。
• クエリ実行: SQL クエリを実行し、結果セットを返します。
• メタデータ取得: データベースのテーブル構造情報を取得します。

⚙️ 環境変数の設定

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

• データベースの認証情報が漏洩しないようにしてください。
• 適切なアクセス制御ポリシーを設定してください。
• 定期的にデータベースの操作ログを監査してください。
• データベースの接続に SSL 暗号化を使用してください。

💡 サンプルの使用シーン

クエリの実行

SELECT * FROM users WHERE age > 18;

データの変更

INSERT INTO users (name, age) VALUES ('张三', 25);

テーブル構造の確認

テーブル "users" の詳細情報を取得します。

すべてのテーブルの一覧表示

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

📌 注意事項

• データベースユーザーは、対応する操作権限を持っている必要があります。
• 本番環境では、より厳格なタイムアウト設定を使用することをおすすめします。
• 長時間実行されるトランザクションは、リソースの占有を防ぐために自動的にロールバックされます。
• DML 操作は、明示的にコミットしないと永続的に有効になりません。
• 設定ファイルに機密情報を平文で保存しないでください。
• 定期的にデータベースをバックアップすることをおすすめします。

📎 付録

エラーコード

戻り値の形式

{
  "code": number,
  "data": any,
  "message": string
}

以上の設定と使用方法に従うことで、PostgreSQL データベースを効率的かつ安全に管理することができます。