SQL MCP 服务器 (TypeScript)

本项目提供了一个 TypeScript 实现 的模型上下文协议 (MCP) 服务器，它使语言模型和其他 MCP 兼容的客户端能够查询 PostgreSQL 数据库——在需要时通过 SSH bastion 隧道。

它专为灵活性和安全的数据库访问而构建，支持具有只读事务的 AWS RDS，并使用基于 stdin/stdout 的通信，使其适用于本地、容器化或 AI 驱动的用例。

特性

• 🔒 SSH bastion 支持，用于通过 SSH 隧道安全访问私有 RDS 实例
• 🐘 使用 pg 库的 PostgreSQL 只读查询引擎
• 📡 基于 STDIO 的 MCP 协议传输
• 🧠 兼容 memory-bank-mcp-server
• ⚙️ 可通过 .env 或环境变量轻松配置
• 🧪 可使用 Jest 和 mocks 进行全面测试

---

安装

克隆存储库并安装依赖项：

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