PostgreSQL MCP 服务器指南

目录结构

项目结构如下：

• dist: 存放编译后的 JavaScript 文件
• src: 核心库文件
• package.json: 依赖管理和构建脚本配置
• tsconfig.json: TypeScript 编译配置

核心脚本说明

目的与功能

这些脚本负责初始化和管理 PostgreSQL 数据库连接，处理事务，并提供数据库操作接口。

主要脚本

index.ts

• 作用: 初始化 MCP 服务器
• 功能:
  • 解析命令行参数
  • 连接 PostgreSQL 数据库
  • 启动监控线程
  • 处理客户端请求

connection-pool.ts

• 作用: 管理数据库连接池
• 功能:
  • 创建和管理数据库连接池
  • 实现连接复用机制
  • 设置连接超时参数
  • 监控连接状态

transaction-monitor.ts

• 作用: 监控事务执行状态
• 功能:
  • 记录事务开始时间
  • 检查事务超时情况
  • 自动回滚长时间未提交的事务
  • 提供事务统计信息

MCP 协议实现

使用示例

const { McpServer } = require('./dist/mcp-server');

// 初始化 MCP 服务器
const server = new McpServer({
  connectionString: 'postgresql://用户名:密码@数据库地址:端口/数据库名',
  transactionTimeoutMs: 15000,
  maxConnections: 20
});

// 启动服务器
server.start();

功能模块

• 连接管理: 提供高效的数据库连接池，支持高并发访问
• 事务控制: 实现事务提交、回滚功能，并提供超时保护机制
• 查询执行: 执行 SQL 查询并返回结果集
• 元数据获取: 获取数据库表结构信息

环境变量配置

安全注意事项

• 确保数据库凭据不泄露
• 配置适当的访问控制策略
• 定期审计数据库操作日志
• 使用SSL加密数据库连接

示例使用场景

1. 执行查询

SELECT * FROM users WHERE age > 18;

2. 执行数据修改

INSERT INTO users (name, age) VALUES ('张三', 25);

3. 查看表结构

获取表 "users" 的详细信息

4. 列出所有表

列出数据库中的所有表

注意事项

• 数据库用户需具备相应操作权限
• 生产环境建议使用更严格的超时设置
• 长时间运行的事务会自动回滚以防资源占用
• DML 操作需显式提交才能永久生效
• 禁止在配置文件中明文存储敏感信息
• 建议定期备份数据库

附录

错误代码

返回值格式

{
  "code": number,
  "data": any,
  "message": string
}

通过以上配置和使用，您可以高效、安全地管理 PostgreSQL 数据库。