PostgreSQL MCP Server

PostgreSQL MCP サーバー

PostgreSQL データベースの管理機能を提供する Model Context Protocol（MCP）サーバーです。このサーバーは、既存の PostgreSQL 環境の分析、実装ガイダンスの提供、データベースの問題のデバッグを支援します。

機能

1. データベース分析（analyze_database）

PostgreSQL データベースの構成とパフォーマンス指標を分析します。

• 構成分析
• パフォーマンス指標
• セキュリティ評価
• 最適化に関する推奨事項

// Example usage
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance" // Optional: "configuration" | "performance" | "security"
}

2. セットアップ手順（get_setup_instructions）

PostgreSQL のインストールと構成に関する手順を段階的に案内します。

• プラットフォーム固有のインストール手順
• 構成に関する推奨事項
• セキュリティのベストプラクティス
• インストール後のタスク

// Example usage
{
  "platform": "linux", // Required: "linux" | "macos" | "windows"
  "version": "15", // Optional: PostgreSQL version
  "useCase": "production" // Optional: "development" | "production"
}

3. データベースのデバッグ（debug_database）

PostgreSQL でよく発生する問題をデバッグします。

• 接続の問題
• パフォーマンスのボトルネック
• ロックの競合
• レプリケーションのステータス

// Example usage
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance", // Required: "connection" | "performance" | "locks" | "replication"
  "logLevel": "debug" // Optional: "info" | "debug" | "trace"
}

前提条件

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

インストール

Smithery 経由でインストール

Smithery 経由で Claude Desktop に PostgreSQL MCP Server を自動的にインストールするには、次の手順を実行します。

npx -y @smithery/cli install @nahmanmate/postgresql-mcp-server --client claude

手動インストール

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": []
       }
     }
   }
   

開発

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

セキュリティに関する考慮事項

1. 接続のセキュリティ

   • 接続プーリングを使用します
   • 接続タイムアウトを実装します
   • 接続文字列を検証します
   • SSL/TLS 接続をサポートします

2. クエリの安全性

   • SQL クエリを検証します
   • 危険な操作を防止します
   • クエリタイムアウトを実装します
   • すべての操作をログに記録します

3. 認証

   • 複数の認証方式をサポートします
   • ロールベースのアクセス制御を実装します
   • パスワードポリシーを適用します
   • 接続認証情報を安全に管理します

ベストプラクティス

1. 常に適切な認証情報を含む安全な接続文字列を使用します
2. 機密性の高い環境では、本番環境向けのセキュリティに関する推奨事項に従います
3. データベースのパフォーマンスを定期的に監視、分析します
4. PostgreSQL のバージョンを常に最新の状態に保ちます
5. 適切なバックアップ戦略を実施します
6. リソースをより適切に管理するため、接続プーリングを使用します
7. 適切なエラー処理とログ記録を実装します
8. セキュリティ監査とアップデートを定期的に実施します

エラー処理

サーバーは包括的なエラー処理を実装しています。

• 接続の失敗
• クエリタイムアウト
• 認証エラー
• 権限の問題
• リソースの制約

評価とテストの実行

evals パッケージは MCP クライアントを読み込み、そのクライアントが index.ts ファイルを実行するため、テストの間に再ビルドする必要はありません。ドキュメント全文はこちらで確認できます。

OPENAI_API_KEY=your-key  npx mcp-eval src/evals/evals.ts src/index.ts

コントリビューション

1. リポジトリをフォークします
2. フィーチャーブランチを作成します
3. 変更をコミットします
4. ブランチにプッシュします
5. プルリクエストを作成します

ライセンス

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