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"
      }
    }
  }
}