Postgres MCP Server

🚀 项目：postgres - mcp - server

这是一个PostgreSQL模型上下文协议服务器，它能让您的大语言模型（LLM）与本地数据库进行交互，为大语言模型在数据库操作方面提供了便利。

⚠️ 重要提示

此项目仍处于实验阶段，请勿在真实数据库上使用该服务器，并且在进行写入查询操作时务必保持谨慎！

🚀 快速开始

📦 安装指南

在使用该项目前，您需要完成以下准备工作：

1. 安装nodeJS。
2. 运行npm install命令来安装项目依赖。
3. 设置以下环境变量：

DATABASE_NAME="你的数据库名称"
DATABASE_USER="你的数据库用户"
DATABASE_PASSWORD="你的数据库密码"
DATABASE_SCHEMA_NAME="你的数据库架构名称" # 通常为`public`

💻 使用示例

基础用法

如果您使用的是VSCode，可以在settings.json中进行如下简单配置：

{
  "chat.mcp.discovery.enabled": true,
  "mcp": {
    "postgresql-database": {
      "command": "npm",
      "type": "stdio",
      "args": ["start", "--prefix", "/path/to/code/postgres-mcp-server"],
      "env": {
        "CUSTOM_INSTRUCTIONS": "数据库名称与当前所在的Git分支相关，始终具有相同的结构：jira_xxxxx，其中jira_xxxxx代表Jira问题编号。这个Jira问题编号总是用于Git分支的开头。因此，您应该能够从当前分支获取它并生成数据库名称",
        "DATABASE_NAME": "my-database-name",
        "DATABASE_USER": "my-user",
        "DATABASE_PASSWORD": "my-password",
        "DATABASE_SCHEMA_NAME": "public"
      }
    }
  }
}