pg-aiguide MCP Server
官方Postgres 技能與文件,協助 AI 編碼工具生成更優質的 PostgreSQL 程式碼。
文件
pg-aiguide
為程式輔助工具提供 AI 最佳化的 PostgreSQL 專業知識
pg-aiguide 能幫助 AI 程式工具寫出品質大幅提升的 PostgreSQL 程式碼。它提供:
- 在官方 PostgreSQL 手冊中進行語義搜尋(支援版本感知)
- AI 最佳化的「技能」 — 由 AI 代理程式自動使用的精選、具觀點的 Postgres 最佳實務
- 擴充生態系文件,從 TimescaleDB 開始,更多內容即將推出
使用方式:
- 透過
npx skills的代理技能 — 適用於 Claude Code、Cursor、Codex、Gemini CLI 以及超過 40 種其他代理程式 - 作為一個公開的 MCP 伺服器,可與任何 AI 程式代理程式搭配使用,或
- 作為一個Claude Code 外掛,針對 Claude 的原生技能支援進行最佳化。
⭐ 為什麼選擇 pg-aiguide?
AI 程式工具經常產生品質不佳的 Postgres 程式碼,例如:
- 過時
- 缺少約束條件和索引
- 不了解現代的 PG 功能
- 與真實世界的最佳實務不一致
pg-aiguide 透過賦予 AI 代理程式深入的、版本化的 PostgreSQL 知識和經過驗證的模式來解決這個問題。
看看差異
https://github.com/user-attachments/assets/5a426381-09b5-4635-9050-f55422253a3d
影片逐字稿
給予 Claude Code 的提示:
請描述你會為一個電子商務網站建立的結構描述兩次,第一次在 tiger mcp 伺服器停用的情況下,第二次在 tiger mcp 伺服器啟用的情況下。每次,都將結構描述寫入目前工作目錄中各自的檔案。然後比較這兩個檔案,並使用定性和定量的理由,讓我知道哪種方法產生了更好的結構描述。對於這個範例,只使用標準的 Postgres。
結果(摘要):
- 多出 4 倍的約束條件
- 多出 55% 的索引(包括部分/表達式索引)
- PG17 推薦的模式
- 現代功能(
GENERATED ALWAYS AS IDENTITY、NULLS NOT DISTINCT) - 更清晰的命名與文件說明
結論:pg-aiguide 能產生更健全、效能更好、更容易維護的結構描述。
🚀 快速入門
代理技能
為你的 AI 程式代理程式安裝精選的 PostgreSQL 最佳實務技能:
npx skills add timescale/pg-aiguide --skill postgres
或以互動方式挑選個別技能:
npx skills add timescale/pg-aiguide
適用於 Claude Code、Cursor、Codex、Gemini CLI、VS Code 以及 超過 40 種其他代理程式。
如需更深入的 PostgreSQL 知識,也可以加入 MCP 伺服器,讓你的代理程式能夠在官方 PostgreSQL、TimescaleDB 和 PostGIS 手冊中進行語義搜尋。
MCP 伺服器
如需在 PostgreSQL、TimescaleDB 和 PostGIS 文件中進行語義搜尋,請加入公開的 MCP 伺服器:
https://mcp.tigerdata.com/docs
使用 JSON 手動設定 MCP
{
"mcpServers": {
"pg-aiguide": {
"url": "https://mcp.tigerdata.com/docs"
}
}
}
或者,它也可以作為 Claude Code 外掛使用:
claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide
依環境安裝
Claude Code
此儲存庫可作為 Claude Code 市集外掛使用。若要安裝,請執行:
claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide
此外掛會使用 skills 目錄中提供的技能,以及我們由 TigerData 託管的公開 MCP 伺服器端點,用於搜尋 PostgreSQL 文件。
Codex
執行以下指令將 MCP 伺服器加入 Codex:
codex mcp add --url "https://mcp.tigerdata.com/docs" pg-aiguide
Cursor
一鍵安裝:
或將以下內容加入 .cursor/mcp.json
{
"mcpServers": {
"pg-aiguide": {
"url": "https://mcp.tigerdata.com/docs"
}
}
}
Gemini CLI
執行以下指令將 MCP 伺服器加入 Gemini CLI:
gemini mcp add -s user pg-aiguide "https://mcp.tigerdata.com/docs" -t http
VS Code
點擊按鈕安裝:
或者,執行以下指令將 MCP 伺服器加入 VS Code:
code --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'
VS Code Insiders
點擊按鈕安裝:
或者,執行以下指令將 MCP 伺服器加入 VS Code Insiders:
code-insiders --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'
Windsurf
將以下內容加入 ~/.codeium/windsurf/mcp_config.json
{
"mcpServers": {
"pg-aiguide": {
"serverUrl": "https://mcp.tigerdata.com/docs"
}
}
}
💡 你的第一個提示
安裝完成後,pg-aiguide 就能回答 Postgres 問題或設計結構描述。
簡單的結構描述範例提示
建立一個用於儲存使用者名稱和唯一電子郵件地址的 Postgres 資料表結構描述。
複雜的結構描述範例提示
你是一位資深軟體工程師。你被指派為一家物聯網裝置公司產生一個 Postgres 結構描述。 這些裝置會收集工廠現場的環境資料。資料包括溫度、濕度、壓力作為 主要資料點,以及其他因裝置而異的測量值。每個裝置都有一個唯一 ID 和一個人類可讀的名稱。我們也想記錄資料收集的時間。針對近期資料的分析 包括根據測量值找出離群值和異常,以及針對特定裝置的資料進行臨時分析。歷史資料分析包括分析單一裝置的歷史資料,或取得所有裝置在長時間內的統計數據。
功能
文件搜尋(MCP 工具)
search_docs統一的搜尋工具,支援跨多個文件來源的語義(向量相似度)和關鍵字(BM25)搜尋:postgres- 官方 PostgreSQL 手冊,按版本範圍限定tiger- Tiger Data 的文件(TimescaleDB 和生態系統)postgis- PostGIS 空間擴充功能文件
技能(AI 最佳化的最佳實務)
-
view_skill
公開由 AI 程式輔助工具自動使用的精選、具觀點的 PostgreSQL 最佳實務技能。這些技能提供以下方面的指導:
- 結構描述設計
- 索引策略
- 資料型別
- 資料完整性和約束條件
- 命名慣例
- 效能調校
- 現代 PostgreSQL 功能
🔌 生態系統文件
目前已支援:
- TimescaleDB(文件 + 技能)
- PostGIS(文件)
即將推出:
- pgvector
我們歡迎針對其他擴充功能和工具做出貢獻。
🛠 開發
請參閱 DEVELOPMENT.md 以了解:
- 在本機執行 MCP 伺服器
- 新增技能
- 新增文件
🤝 貢獻
我們歡迎:
- 新的 Postgres 最佳實務技能
- 額外的文件語料庫
- 搜尋品質的改進
- 錯誤回報和功能構想
📄 授權
Apache 2.0