Postgres Query

🚀 MCP PostgreSQL クエリサーバ

このプロジェクトは、モデルコンテキストプロトコル（MCP）サーバを実装しており、PostgreSQL データベースを読み取り専用モードでクエリするために設計されています。Claude Desktop やその他の MCP クライアントと連携することができます。

🚀 クイックスタート

この MCP PostgreSQL クエリサーバは、安全な読み取り専用インターフェースを介して PostgreSQL データベースにアクセスできるようにし、Claude Desktop との統合を可能にします。また、SQL クエリの検証やクエリのタイムアウト保護も備えています。

✨ 主な機能

• 安全な読み取り専用インターフェースを通じて PostgreSQL データベースにアクセスできます。
• MCP プロトコルを介して Claude Desktop と統合できます。
• SQL クエリの検証を行い、SELECT クエリのみを実行します。
• クエリのタイムアウト保護（10 秒）があります。
• 読み取り専用のデータベースアクセスにより、セキュリティを確保します。
• 潜在的に有害な SQL 操作をブロックするクエリ検証機能があります。
• クエリ結果は構造化された JSON 形式で返されます。

📦 インストール

# リポジトリをクローンする
git clone https://github.com/RathodDarshil/mcp-postgres-query-server.git
cd mcp-postgres-query-server

# 依存関係をインストールする
npm install

# プロジェクトをビルドする
npm run build

📚 ドキュメント

Claude Desktop への接続

Claude Desktop を自動的に起動し、MCP サーバに接続するように構成することができます。

1. Claude Desktop の設定ファイルにアクセスします。
   • Claude Desktop を開きます。
   • 設定 > 開発者 > 設定を編集 を選択します。
   • これにより、デフォルトのテキストエディタで設定ファイルが開きます。
2. claude_desktop_config.json の mcpServers セクションに postgres-query サーバを追加します。

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/path/to/your/mcp-postgres-query-server/dist/index.js",
                "postgresql://username:password@hostname:port/database"
            ]
        }
    }
}

3. /path/to/your/ を実際のプロジェクトのパスに置き換えます。
4. PostgreSQL の接続文字列 を実際のデータベースの資格情報に置き換えます。
5. ファイルを保存し、Claude Desktop を再起動します。MCP サーバは、設定の MCP サーバ選択ドロップダウンメニューに表示されるはずです。

設定例

以下は、postgres-query を含む完全な設定ファイルの例です。

{
    "mcpServers": {
        "postgres-query": {
            "command": "node",
            "args": [
                "/Users/darshilrathod/mcp-servers/mcp-postgres-query-server/dist/index.js",
                "postgresql://user:password@localhost:5432/mydatabase"
            ]
        }
    }
}

設定の更新

Claude Desktop の設定を更新するには、以下の手順を実行します。

1. Claude Desktop を開きます。
2. 設定 > 開発者 > 設定を編集 を選択します。
3. 設定ファイルを変更します。
4. ファイルを保存します。
5. Claude Desktop を再起動して、変更を有効にします。
6. MCP サーバのコードを更新した場合は、再起動する前に npm run build で再構築してください。

💻 使用例

基本的な使用法

{
  "query": "SELECT * FROM users LIMIT 5",
  "result": {
    "rows": [
      { "id": 1, "name": "Alice" },
      { "id": 2, "name": "Bob" }
    ],
    "rowCount": 2,
    "columns": ["id", "name"]
  }
}

🔧 技術詳細

API

query-postgres

構成された PostgreSQL データベースに対して読み取り専用の SQL クエリを実行します。

• パラメータ:
  • query (string): 実行する SELECT SQL クエリ
• レスポンス:
  • 以下の内容を含む JSON オブジェクト:
    • rows: 結果セットの行
    • rowCount: 返された行数
    • columns: クエリの結果列

開発

• プロジェクト構造:
  • src/: コアのサーバ実装が含まれています。
  • dist/: ビルド出力ディレクトリです。
  • package.json: プロジェクトの依存関係とスクリプトが定義されています。
  • README.md: プロジェクトのドキュメントです。
• 貢献ガイドライン:
  • コードを提出する前に、npm スクリプトを使用してテストを実行してください。
  • プロジェクトのコード規約に従ってください。

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

• データベースの資格情報の安全性を確保し、コード内に平文で保存しないでください。
• 環境変数または設定管理ツールを使用して、機密情報を管理してください。
• 定期的にサーバのセキュリティポリシーを監査し、更新してください。