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集成