MCP Postgres Query Server

🚀 MCP PostgreSQLクエリサーバ

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

🚀 クイックスタート

このプロジェクトは、以下の機能を持つモデルコンテキストプロトコル（MCP）サーバを実装しています。

1. PostgreSQLデータベースへの安全な読み取り専用インターフェースを提供します。
2. MCPプロトコルを通じてClaude Desktopと統合されます。
3. SQLクエリの検証を行い、SELECTクエリのみを実行することを保証します。
4. クエリのタイムアウト保護（10秒）があります。

✨ 主な機能

• 読み取り専用データベースアクセス：SELECTクエリのみを許可し、安全性を確保します。
• クエリ検証：潜在的に有害なSQL操作を防止します。
• タイムアウト保護：実行時間が10秒を超えるクエリは自動的に終了されます。
• MCPプロトコルサポート：完全なモデルコンテキストプロトコルの実装です。
• JSONレスポンスフォーマット：クエリ結果は構造化されたJSON形式で返されます。

📦 インストール

必要条件

• Node.js（v14以上）
• npm（Node.jsに付属）
• PostgreSQLデータベース（コマンドラインで提供される接続詳細）

インストール手順

# リポジトリをクローンする
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-serverを追加します。

{
    "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で再構築してください。

API

ツール

query-postgres

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

• パラメータ：
  • query（文字列）：実行するSQL SELECTクエリ
• レスポンス：
  • JSONオブジェクトには以下が含まれます。
    • rows：結果セットの行
    • columns：列情報
    • rowCount：行数
    • type：クエリのタイプ

リクエスト例

{
  "procedure": "query-postgres",
  "params": {
    "query": "SELECT * FROM users LIMIT 10"
  }
}

レスポンス例

{
  "rows": [
    { "id": 1, "name": "Alice" },
    { "id": 2, "name": "Bob" }
  ],
  "columns": ["id", "name"],
  "rowCount": 2,
  "type": "SELECT"
}

開発

PostgreSQL接続の設定

config.jsファイルで、PostgreSQLの接続詳細を設定します。

module.exports = {
    host: 'localhost',
    port: 5432,
    user: 'yourdbuser',
    password: 'yourdbpassword',
    database: 'yourdatabasename'
};

クエリの実行

index.jsファイルで、クエリを処理するロジックを定義します。

const { Pool } = require('pg');
const pool = new Pool(require('./config'));

async function queryPostgres(query) {
    try {
        const result = await pool.query(query);
        return {
            rows: Array.from(result.rows),
            columns: result.columns,
            rowCount: result.rowCount,
            type: result.command
        };
    } catch (error) {
        throw new Error(`Query failed: ${error.message}`);
    }
}

module.exports = { queryPostgres };

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

• PostgreSQLの資格情報を安全に保管し、平文で保存しないようにします。
• 適切なファイアウォール規則を設定して、データベースへのアクセスを制限します。
• 定期的にデータベースをバックアップして、データの損失を防ぎます。
• SSL接続を有効にして、データベースとの通信を暗号化します。