SQL Tunnel

🚀 SQL MCP サーバー（TypeScript）

このプロジェクトは、TypeScriptベースのモデルコンテキストプロトコル（MCP）サーバーを提供します。これにより、言語モデルやその他のMCP互換クライアントがSSHトンネルを通じてPostgreSQLデータベースを安全にクエリできます。

柔軟で安全なデータベースアクセスを目的として構築され、AWS RDSの読み取り専用トランザクションをサポートし、stdin/stdoutベースの通信を使用しており、ローカル、コンテナ化、AI駆動など様々なユースケースに対応しています。

✨ 主な機能

• 🔒 SSHトンネルを通じたプライベートRDSインスタンスへの安全なアクセス
• 🐘 pg ライブラリを使用したPostgreSQL読み取り専用クエリエンジン
• 📡 STDIOベースのMCPプロトコル伝送
• 🧠 memory-bank-mcp-server との互換性
• ⚙️ .env ファイルまたは環境変数による簡単な設定
• 🧪 Jestとモックを使用した包括的なテスト

📦 インストール

リポジトリをクローンし、依存関係をインストールします。

git clone https://github.com/your-org/sql-mcp-server.git
cd sql-mcp-server
npm install
npm run build

設定（オプションの .env ファイル）

プロジェクトのルートディレクトリに .env ファイルを作成します。

DB_USER=postgres
DB_PASS=yourpassword
DB_HOST=localhost
DB_PORT=5432
DB_NAME=mydatabase
USE_SSH_TUNNEL=true
SSH_BASTION_HOST=bastion.example.com
SSH_BASTION_USER=ec2-user
SSH_PRIVATE_KEY_PATH=~/.ssh/id_rsa

使用方法

npxを使用してサーバーを起動します。

npx -y @modelcontextprotocol/server-postgres postgresql://<user>:<pass>@localhost:5433/<dbname>

SSHトンネルを使用せずに直接接続する場合は、適切な環境変数を設定します。

DB_HOST=rds-host.amazonaws.com DB_PORT=5432 npx -y @modelcontextprotocol/server-postgres postgresql://<user>:<pass>@rds-host.amazonaws.com/<dbname>

💻 使用例

基本的な使用法

入力例

{
  "type": "call_tool",
  "params": {
    "name": "query",
    "arguments": {
      "sql": "SELECT * FROM users LIMIT 10"
    }
  }
}

出力例

{
  "content": [
    {
      "type": "text",
      "text": "[{\"id\":1,\"name\":\"Alice\"}]"
    }
  ],
  "isError": false
}

📚 ドキュメント

• アーキテクチャ
• ドメインモデル
• 用語集
• コーディング標準
• 技術スタック
• ユーザーガイド

📄 ライセンス

MIT

コントリビューションガイド

コミュニティからのコントリビューションを歓迎します！詳細は CONTRIBUTING.md をご覧ください。

互換性

この実装はモデルコンテキストプロトコル（MCP）に準拠しており、以下と互換性があります。

• memory-bank-mcp-server
• Claude Desktop（STDIO経由）
• Cursor IDE
• Supabase + MCP 統合