MCP PostgreSQL Server

MCP PostgreSQL Server

site icon
2025.04.15 1
JavaScript数据库服务数据分析数据库
MCP PostgreSQL Server 是一个基于 Model-Controller-Provider (MCP) 模式的服务,主要用于连接 PostgreSQL 数据库,提供表结构浏览、只读 SQL 查询执行、数据分析模板等功能。该服务适用于需要安全访问数据库并进行数据分析的场景。
View on GitHub

Overview

基本能力

产品定位

MCP PostgreSQL Server 是一个数据库中间件服务,专注于提供安全、高效的数据库访问和分析能力。

核心功能

  • Schema Exploration: 浏览数据库的表结构和列信息。
  • Read-only Query Execution: 安全地执行只读 SQL 查询。
  • Data Analysis Prompts: 提供预置的数据分析模板。
  • Data Visualization: 生成可视化数据。
  • Relationship Exploration: 可视化表之间的关系和外键。
  • API Documentation: 自动生成 OpenAPI 规范。

适用场景

  • 数据库结构浏览和探索。
  • 安全执行只读查询。
  • 快速生成数据分析报告。
  • 数据库关系可视化。

工具列表

  • Schema Endpoints: 用于浏览数据库结构。
  • Query Endpoints: 用于执行 SQL 查询。
  • Analysis Prompt Endpoints: 用于生成和执行数据分析模板。

常见问题解答

  • 如何配置数据库连接? 通过 .env 文件配置数据库连接信息。
  • 如何启动服务? 使用 npm start 命令启动服务。
  • 如何开发调试? 使用 npm run dev 启动开发模式。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 确保已安装 PostgreSQL 数据库。

安装教程

  1. 克隆仓库: git clone <repository-url> cd mcp-postgres-server
  2. 安装依赖: npm install
  3. 创建 .env 文件: cp .env.template .env
  4. 更新 .env 文件中的数据库连接信息。
  5. 启动服务: npm start

调试方式

  1. 开发模式启动: npm run dev
  2. 运行测试: npm test
  3. 代码检查: npm run lint

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。