Postgresql Explorer

🚀 PostgreSQL MCP サーバー

Model Context Protocol (MCP) Python SDK を使用して実装された PostgreSQL MCP サーバーです。MCP は、LLM アプリケーションが外部データソースとシームレスに統合できるようにするオープンプロトコルです。このサーバーにより、AI エージェントは標準化されたインターフェースを介して PostgreSQL データベースとやり取りできます。

✨ 主な機能

• データベーススキーマの一覧表示
• スキーマ内のテーブルの一覧表示
• テーブル構造の説明
• テーブルの制約と関係の一覧表示
• 外部キー情報の取得
• SQL クエリの実行

📦 インストール

Smithery を使用した自動インストール

Smithery を通じて、Claude Desktop 用の PostgreSQL MCP サーバーを自動インストールします。

npx -y @smithery/cli install @gldc/mcp-postgres --client claude

手動インストール

1. このリポジトリをクローンします。

git clone <repository-url>
cd mcp-postgres

2. 仮想環境を作成してアクティブ化します（推奨）。

python -m venv venv
source venv/bin/activate  # Windows の場合は：venv\Scripts\activate

3. 依存関係をインストールします。

pip install -r requirements.txt

💻 使用例

基本的な使用法

1. PostgreSQL 接続文字列で MCP サーバーを起動します。

python postgres_server.py "postgresql://username:password@host:port/database"

2. このサーバーは以下のツールを提供します。

• query：SQL クエリの実行
• list_schemas：利用可能なすべてのスキーマの一覧表示
• list_tables：特定のスキーマ内のすべてのテーブルの一覧表示
• describe_table：テーブル構造の詳細情報の取得
• get_foreign_keys：テーブルの外部キー関係の取得
• find_relationships：テーブルの明示的および暗黙的な関係の発見

高度な使用法

mcp.json との連携

このサーバーを MCP 互換ツール（Cursor など）に統合するには、~/.cursor/mcp.json に追加します。

{
  "servers": {
    "postgres": {
      "command": "/path/to/venv/bin/python",
      "args": [
        "/path/to/postgres_server.py",
        "postgresql://username:password@host:5432/database?ssl=true"
      ]
    }
  }
}

以下を置き換えます。

• /path/to/venv：仮想環境のパス
• /path/to/postgres_server.py：サーバースクリプトの絶対パス
• 接続文字列：PostgreSQL データベースの資格情報

注意：mcp.json ファイルには機密性の高いデータベース資格情報が含まれるため、セキュリティを確保してください。

🔧 技術詳細

前提条件

• Python 3.x
• PostgreSQL データベースサーバー
• PostgreSQL データベースへのアクセス権限

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

• コード内で機密性の高いデータベース資格情報を公開しないでください。
• 環境変数またはセキュアな設定ファイルを使用して接続文字列を保存してください。
• 接続プーリングを使用してリソース管理の効率を向上させることを検討してください。
• 適切なアクセス制御と認証を実装してください。

📚 ドキュメント

関連プロジェクト

• MCP プロトコル
• PostgreSQL 公式ドキュメント

📄 ライセンス

著作権 © 2023 あなたの名前。全ての権利を保有します。

以下のライセンス契約に基づいてライセンスされています。

[TO BE ADDED]