Pg MCP Server

🚀 PG_MCP服務器

PG_MCP服務器是一款通用的PostgreSQL MCP服務器，基於PostgreSQL + PostGIS實現，支持Stdio和SSE傳輸，在本地部署大語言模型時，能高效進行上下文管理。

🚀 快速開始

安裝

在main.go中：

// 這裡可以設置數據庫交互的連接字符串
schemaLoadConnID, err := dbService.RegisterConnection(tempCtx, "postgres://mcp_user:mcp123456@192.168.2.19:5432/postgres")

格式為postgres://user:pass@host:port/db ，或者可以通過.env文件配置，只需uncomment並設置SCHEMA_LOAD_DB_URL變量即可。這裡，RegisterConnection給服務器一個初始連接字符串以緩存數據庫表信息。
🏁 建議為服務器創建專用角色。以下是SQL語句：

-- 創建新角色並設置密碼
CREATE ROLE mcp_user WITH LOGIN PASSWORD 'mcp123456';

-- 設置mcp_user的基本權限
GRANT CONNECT ON DATABASE postgres TO mcp_user;
GRANT USAGE ON SCHEMA public TO mcp_user;

-- 授予public模式下所有現有表的SELECT權限
GRANT SELECT ON ALL TABLES IN SCHEMA public TO mcp_user;

-- 自動授予public模式下新表的SELECT權限給mcp_user
ALTER DEFAULT PRIVILEGES IN SCHEMA public
   GRANT SELECT ON TABLES TO mcp_user;

-- 創建temp模式
CREATE SCHEMA temp;

-- 授予temp模式上的所有權限給mcp_user
GRANT USAGE, CREATE ON SCHEMA temp TO mcp_user;
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA temp TO mcp_user;

-- 自動授予temp模式下新表的SELECT、INSERT、UPDATE和DELETE權限給mcp_user
ALTER DEFAULT PRIVILEGES IN SCHEMA temp
   GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO mcp_user;

運行

使用Docker運行

1. 確保您已安裝Docker。
2. 在項目目錄下執行以下命令：

docker-compose up --build

這將構建並啟動服務。

直接運行

要直接運行，請確保您已經安裝了所有依賴項。在終端中導航到項目根目錄並運行：

go run main.go

✨ 主要特性

在本地部署大語言模型時，上下文管理需要高效。每次調用時讀取數據庫架構會消耗時間和寶貴的上下文令牌。該項目採用了預處理方法。它原生支持從數據庫獲取表結構，併為LLM提供描述性信息：

• 利用工具描述和輸入模式隱式或顯式地傳達架構信息。
• 在初始化時利用MCP資源讀取表名、列、約束、外鍵、索引、幾何類型和EPSG代碼，為大型模型建立基礎理解。

🔧 技術細節

擴展支持

• PostGIS: 已實現
• PgVector: 已實現
• PgRouting: 進行中

待辦事項

• 溫表管理機制
  • 實現表結構緩存
  • 增加表結構變化檢測
  • 制定失效策略
• 單元測試
  • 表結構讀取與解析的單元測試
  • SQL注入和XSS防護測試

📄 許可證

PostGIS和PgVector的相關描述引用自另一個開源項目：https://github.com/stuzero/pg-mcp-server 🙏🙏paginator
這種提供上下文的思路令人耳目一新。

📚 詳細文檔

中文文檔

📌 重要提示

⚠️ 重要提示

數據庫需要定義角色以防止SQL注入。授予public模式上的SELECT權限，以避免敏感數據洩露。授予新角色對temp模式下所有表的SELECT、INSERT、UPDATE和DELETE權限，以確保數據隔離。