MCP PostgreSQL 服务器

一个模型-控制器-提供者 (MCP) 服务器，它：

• 连接到 PostgreSQL 数据库
• 将表模式公开为资源
• 提供用于运行只读 SQL 查询的工具
• 包含用于常见数据分析任务的提示

功能

• 模式探索: 浏览数据库模式、表和列
• 只读查询执行: 安全地针对您的数据库运行 SQL 查询
• 数据分析提示: 用于常见分析任务的预构建 SQL 模板
• 数据可视化: 生成用于可视化的数据
• 关系探索: 可视化表关系和外键
• API 文档: 自动生成的 OpenAPI 规范

架构

此应用程序遵循模型-控制器-提供者 (MCP) 模式：

• 模型层: 与数据库直接交互
• 提供者层: 业务逻辑和数据处理
• 控制器层: API 端点和请求处理

安全特性

• 只读查询验证
• SQL 注入保护
• 速率限制
• 参数化查询
• 身份验证支持
• CORS 配置

安装

1. 克隆存储库：

   git clone <repository-url>
   cd mcp-postgres-server
   

2. 安装依赖项：

   npm install
   

3. 基于 .env.template 创建一个 .env 文件：

   cp .env.template .env
   

4. 使用您的 PostgreSQL 数据库凭据更新 .env 文件。

5. 启动服务器：

   npm start
   

配置

所有配置都通过环境变量进行管理：

• 服务器: 端口、环境、CORS 设置
• 数据库: 连接详细信息、连接池设置
• 安全: JWT 设置、速率限制
• 查询: 执行限制、结果大小限制

API 端点

模式端点

• GET /api/schemas - 列出所有模式
• GET /api/schemas/:schema/tables - 列出模式中的表
• GET /api/schemas/:schema/tables/:table - 获取表模式详细信息
• GET /api/schemas/:schema/relationships - 获取表关系
• GET /api/structure - 获取完整的数据库结构
• GET /api/search?q=term - 搜索表和列

查询端点

• POST /api/query - 执行 SQL 查询
• POST /api/query/explain - 获取查询执行计划
• GET /api/schemas/:schema/tables/:table/sample - 获取示例数据
• GET /api/schemas/:schema/tables/:table/stats - 获取表统计信息

分析提示端点

• GET /api/prompts - 列出分析提示模板
• GET /api/prompts/:templateId - 获取提示模板详细信息
• POST /api/prompts/:templateId/generate - 从模板生成 SQL
• GET /api/schemas/:schema/tables/:table/analysis/suggest - 获取分析建议

示例查询

基本表查询

// API 请求
fetch('/api/query', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    sql: 'SELECT * FROM users LIMIT 10'
  })
})
.then(response => response.json())
.then(data => console.log(data));

使用分析提示

// 获取表的建议分析
fetch('/api/schemas/public/tables/orders/analysis/suggest')
.then(response => response.json())
.then(suggestions => {
  // 使用一个建议
  const suggestionId = suggestions.data[0].templateId;
  const params = suggestions.data[0].params;
  
  // 从模板生成 SQL
  return fetch(`/api/prompts/${suggestionId}/generate`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ params })
  });
})
.then(response => response.json())
.then(data => {
  // 执行生成的 SQL
  return fetch('/api/query', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ sql: data.data.sql })
  });
})
.then(response => response.json())
.then(results => console.log(results));

开发

• 在开发模式下运行：npm run dev
• 运行测试：npm test
• 检查代码风格：npm run lint

许可证

MIT