Nahmanmate Postgresql MCP Server

🚀 PostgreSQL MCP サーバー

このサーバーは、PostgreSQL データベースの管理機能を提供する Model Context Protocol (MCP) サーバーです。既存の PostgreSQL 設定を分析し、実装ガイドを提供し、データベースの問題をデバッグするのに役立ちます。

🚀 クイックスタート

PostgreSQL MCP サーバーを使用することで、PostgreSQL データベースの分析、設定、デバッグを行うことができます。以下に基本的な使い方を示します。

✨ 主な機能

1. データベース分析 (analyze_database)

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

• 設定分析
• パフォーマンス指標
• セキュリティ評価
• 最適化提案

// 示例用法
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance" // 可选： "configuration" | "performance" | "security"
}

2. インストール説明 (get_setup_instructions)

PostgreSQL のインストールと設定の手順を提供します。

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

// 示例用法
{
  "platform": "linux", // 必需： "linux" | "macos" | "windows"
  "version": "15", // 可选： PostgreSQL 版本
  "useCase": "production" // 可选： "development" | "production"
}

3. データベースデバッグ (debug_database)

PostgreSQL の一般的な問題をデバッグします。

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

// 示例用法
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance", // 必需： "connection" | "performance" | "locks" | "replication"
  "logLevel": "debug" // 可选： "info" | "debug" | "trace"
}

📦 インストール

前提条件

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

💻 使用例

基本的な使用法

上記の各機能のコード例を参照してください。

🔧 技術詳細

開発

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

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

1. 接続セキュリティ
   • コネクションプールを使用する
   • 接続タイムアウトを実装する
   • 接続文字列の検証を行う
   • SSL/TLS 接続をサポートする
2. クエリセキュリティ
   • SQL クエリの検証を行う
   • 危険な操作を防止する
   • クエリタイムアウトを実施する
   • すべての操作を記録する
3. 認証
   • 複数の認証方法をサポートする
   • ロールベースのアクセス制御を実装する
   • パスワードポリシーを実行する
   • 接続資格情報を安全に管理する

ベストプラクティス

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

エラー処理

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

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

貢献ガイド

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. ブランチにプッシュします。
5. Pull Request を作成します。

📄 ライセンス

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