Postgresql Database Management Server

🚀 PostgreSQL MCP サーバー

PostgreSQL MCP（モデルコンテキストプロトコル）サーバーは、PostgreSQL データベースを管理および操作するためのツールです。データベース分析、デバッグ、スキーマ管理、データ移行、リアルタイム監視など、様々な機能を提供します。

🚀 クイックスタート

PostgreSQL MCP サーバーを使うことで、PostgreSQL データベースの管理や操作が効率的に行えます。以下では、その機能や使い方、セットアップ方法について説明します。

✨ 主な機能

1. データベース分析

• 説明: PostgreSQL データベースの包括的な分析を提供し、パフォーマンス指標や健全性チェックを行います。
• 使用例:

// データベースのパフォーマンスを分析する
const analysis = await postgresqlMcpServer.analyzeDatabase(connectionString);

2. データベースデバッグ

• 説明: データベース内の問題の特定と解決を支援し、クエリの最適化やエラーのトラブルシューティングを行います。
• 使用例:

// 特定のクエリをデバッグする
const debugResult = await postgresqlMcpServer.debugQuery(connectionString, query);

3. スキーマ管理

• 説明: データベースのスキーマを管理および操作する機能を提供し、テーブル、インデックス、ビューなどを扱います。
• 使用例:

// データベースのスキーマを取得する
const schema = await postgresqlMcpServer.getSchema(connectionString);

4. データ移行

• 説明: 異なる PostgreSQL データベース間でのデータ移行をサポートし、フィルタリングやクリーニング操作も可能です。
• 使用例:

// データを移行する
await postgresqlMcpServer.migrateData(sourceConnectionString, targetConnectionString);

5. リアルタイム監視

• 説明: PostgreSQL データベースのリアルタイム監視機能を提供し、パフォーマンス指標、クエリ活動、ロック情報などを監視します。
• 使用例:

// データベースの状態を監視する
const monitoringResult = await postgresqlMcpServer.monitorDatabase(connectionString);

📦 インストール

前提条件

• Node.js >= 18.0.0
• PostgreSQL サーバー（対象データベースの操作に必要）
• 対象の PostgreSQL インスタンスへのネットワークアクセス

インストール手順

1. リポジトリをクローンします。
2. 依存関係をインストールします。

npm install

3. サーバーをビルドします。

npm run build

4. 以下の内容を MCP 設定ファイルに追加します。

{
  "mcpServers": {
    "postgresql-mcp": {
      "command": "node",
      "args": ["/path/to/postgresql-mcp-server/build/index.js"],
      "disabled": false,
      "alwaysAllow": [],
      "env": {
        "POSTGRES_CONNECTION_STRING": "postgresql://username:password@server:port/dbname"
      }
    }
  }
}

🔧 開発に関する情報

• npm run dev - ホットリロード付きで開発サーバーを起動します。
• npm run lint - ESLint を実行します。
• npm test - テストを実行します。

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

1. 接続の安全性

• 接続プールを使用する
• 接続タイムアウトを実装する
• 接続文字列の検証を行う
• SSL/TLS 接続をサポートする

2. クエリの安全性

• SQL クエリの検証を行う
• 危険な操作を防止する
• クエリタイムアウトを実施する
• すべての操作を記録する

3. 認証

• 複数の認証方法をサポートする
• ロールベースのアクセス制御を実装する
• パスワードポリシーを実行する
• 接続資格情報を安全に管理する

💡 使用上のベストプラクティス

1. 常に適切な資格情報を含む安全な接続文字列を使用します。
2. 本番環境のセキュリティ推奨事項に従います。
3. 定期的にデータベースのパフォーマンスを監視および分析します。
4. PostgreSQL のバージョンを最新に保ちます。
5. 適切なデータバックアップ戦略を実施します。
6. 接続プールを使用してリソース管理を最適化します。
7. 適切なエラー処理とロギングを実装します。
8. 定期的にセキュリティ監査と更新を行います。

🔧 エラー処理

サーバーは包括的なエラー処理を実装しており、以下のようなエラーに対応します。

• 接続失敗
• クエリタイムアウト
• 認証エラー
• ロック問題

🤝 コントリビューションガイド

PostgreSQL MCP サーバーへの貢献方法については、プロジェクトリポジトリ内のコントリビューションガイドを参照してください。

📄 ライセンス

このプロジェクトは LICENSE ライセンスに従います。