pg-aiguide

官方

Postgres 技能與文件,協助 AI 編碼工具生成更優質的 PostgreSQL 程式碼。

你可以用 Pg Aiguide MCP 做什麼?

  • 語意化文件搜尋 — 讓您的 AI 透過 search_docs 尋找 PostgreSQL、TimescaleDB 或 PostGIS 的指引,並提供具版本感知的結果。
  • Schema 設計協助 — 請求生產級 Postgres schema,採用現代功能如 GENERATED ALWAYS AS IDENTITY 與 NULLS NOT DISTINCT。
  • 索引策略建議 — 取得針對您的查詢模式與資料分佈所量身打造的部分索引與表達式索引建議。
  • 最佳實務技能 — 透過 view_skill 存取 PostgreSQL 在約束、命名慣例與效能調校方面的精選模式。
  • 擴充功能生態系查詢 — 查詢 TimescaleDB 與 PostGIS 文件,以取得擴充功能專屬的 SQL 語法與功能。

託管 MCP 伺服器

npx add-mcp 'https://mcp.tigerdata.com/docs'

可安裝到 Claude Code、Codex、Cursor 等客戶端

文件

pg-aiguide

為 AI 最佳化的 PostgreSQL 專業知識,專供程式設計助手使用

pg-aiguide 協助 AI 程式設計工具撰寫品質大幅提升的 PostgreSQL 程式碼。它提供:

  • 語意搜尋,涵蓋官方 PostgreSQL 手冊(具版本感知能力)
  • AI 最佳化的「技能」 — 經策劃且具權威性的 Postgres 最佳實務,AI 代理會自動使用
  • 擴充生態系統文件,從 TimescaleDB 開始,未來將推出更多

使用方式:

  • 作為 Agent Skills,透過 npx skills — 可與 Claude Code、Cursor、Codex、Gemini CLI 及 40 多種其他代理搭配使用
  • 作為可與任何 AI 程式設計代理搭配使用的公開 MCP 伺服器,或
  • 作為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 的提示:

請描述您會為電子商務網站建立的 schema 兩次,第一次停用 tiger mcp 伺服器,第二次啟用 tiger mcp 伺服器。每次請將 schema 寫入目前工作目錄中的個別檔案。然後比較這兩個檔案,並告訴我哪種方法產生了較佳的 schema,請同時使用質性與量化理由。在此範例中,僅使用標準 Postgres。

結果(摘要):

  • 約束條件多 4 倍
  • 索引多 55%(包含部分/表達式索引)
  • 採用 PG17 建議的設計模式
  • 現代功能(GENERATED ALWAYS AS IDENTITY、NULLS NOT DISTINCT)
  • 更清晰的命名與文件

結論:pg-aiguide 能產出更穩健、高效能且易於維護的 schema。

🚀 快速入門

Agent Skills

為您的 AI 程式設計代理安裝經策劃的 PostgreSQL 最佳實務技能:

npx skills add timescale/pg-aiguide --skill postgres

或安裝 schema 探索技能以調查現有的 PostgreSQL 資料庫:

npx skills add timescale/pg-aiguide --skill schema-exploration

或以互動方式挑選個別技能:

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

依環境安裝

Install in Cursor Install in VS Code Install in VS Code Insiders Install in Visual Studio Install in Goose Add MCP Server pg-aiguide to LM Studio

Claude Code

此儲存庫作為 claude code marketplace 外掛程式。若要安裝,請執行:

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

一鍵安裝:

Install MCP Server

或將以下內容新增至 .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
OpenCode

將以下內容新增至您的全域 OpenCode 設定檔(~/.config/opencode/opencode.json),或新增至專案層級的 opencode.json。請參閱 OpenCode 設定文件 以了解檔案位置的詳細資訊,並參閱 MCP 伺服器文件 以了解 mcp 選項的詳細資訊。

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "pg-aiguide": {
      "type": "remote",
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

將 use pg-aiguide 新增至您的提示中,以使用 pg-aiguide 工具。

Visual Studio

按一下按鈕進行安裝:

Install in Visual Studio

VS Code

按一下按鈕進行安裝:

Install in VS Code

或者,執行以下指令以將 MCP 伺服器新增至 VS Code:

code --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'
VS Code Insiders

按一下按鈕進行安裝:

Install in 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 問題或設計 schema。

簡單 schema 範例提示

建立一個 Postgres 資料表 schema,用於儲存使用者名稱與唯一的電子郵件地址。

複雜 schema 範例提示

您是一位資深軟體工程師。您接獲一項任務,要為一家 IoT 裝置公司產生 Postgres schema。 這些裝置在工廠廠房收集環境資料。資料包括溫度、濕度、氣壓等主要資料點,以及其他因裝置而異的測量值。每個裝置都有唯一 ID 與人類可讀的名稱。我們也希望記錄資料收集的時間。近期資料的分析包括根據測量值找出離群值與異常,以及分析特定裝置的資料以進行臨時分析。歷史資料分析包括分析單一裝置的資料歷史,或取得所有裝置在長時間內的統計資料。

功能

文件搜尋(MCP 工具)

  • search_docs 統一搜尋工具,支援跨多個文件來源的語意(向量相似度)與關鍵字(BM25)搜尋:
    • postgres - 官方 PostgreSQL 手冊,依版本界定範圍
    • tiger - Tiger Data 的文件(TimescaleDB 與生態系統)
    • postgis - PostGIS 空間擴充文件

技能(AI 最佳化的最佳實務)

  • view_skill
    提供經策劃且具權威性的 PostgreSQL 最佳實務技能,AI 程式設計助手會自動使用。

    這些技能提供以下方面的指引:

    • 探索現有的 PostgreSQL schema 與物件
    • Schema 設計
    • 索引策略
    • 資料型別
    • 資料完整性與約束條件
    • 命名慣例
    • 效能調校
    • 現代 PostgreSQL 功能

🔌 生態系統文件

目前支援:

  • TimescaleDB(文件 + 技能)
  • PostGIS(文件)

即將推出:

  • pgvector

我們歡迎為其他擴充與工具貢獻內容。

🛠 開發

請參閱 DEVELOPMENT.md 以了解:

  • 在本機執行 MCP 伺服器
  • 新增技能
  • 新增文件

🤝 貢獻

我們歡迎:

  • 新的 Postgres 最佳實務技能
  • 額外的文件語料庫
  • 搜尋品質改善
  • 錯誤回報與功能建議

📄 授權

Apache 2.0