Postgres Ai Guide

pg-aiguide

面向编码助手的 AI 优化 PostgreSQL 专业知识

pg-aiguide 帮助 AI 编码工具编写出更出色的 PostgreSQL 代码。它提供：

• 官方 PostgreSQL 手册的语义搜索（支持版本识别）
• AI 优化的“技能”——精心整理、立场明确的 Postgres 最佳实践，供 AI Agent 自动使用
• 扩展生态系统文档，目前从 TimescaleDB 开始，更多内容即将推出

可通过以下方式使用：

• 通过 npx skills 使用 Agent Skills——支持 Claude Code、Cursor、Codex、Gemini CLI 以及其他 40 多种 Agent
• 使用可供任何 AI 编码 Agent 调用的公共 MCP 服务，或
• 使用针对 Claude 原生技能支持优化的 Claude Code 插件。

⭐ 为什么选择 pg-aiguide？

AI 编码工具经常生成以下类型的 Postgres 代码：

• 过时
• 缺少约束和索引
• 不了解现代 PG 功能
• 不符合实际应用中的最佳实践

pg-aiguide 通过为 AI Agent 提供深入、按版本区分的 PostgreSQL 知识和经过验证的模式，解决这些问题。

看看效果有何不同

https://github.com/user-attachments/assets/5a426381-09b5-4635-9050-f55422253a3d

🚀 快速入门

Agent Skills

为你的 AI 编码 Agent 安装精心整理的 PostgreSQL 最佳实践技能：

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

或者安装架构探索技能，以调查现有的 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 多种 Agent。

要获取更深入的 PostgreSQL 知识，还可以添加 MCP 服务，让你的 Agent 能够对 PostgreSQL、TimescaleDB 和 PostGIS 官方手册进行语义搜索。

MCP 服务

要对 PostgreSQL、TimescaleDB 和 PostGIS 文档进行语义搜索，请添加公共 MCP 服务：

https://mcp.tigerdata.com/docs

{
  "mcpServers": {
    "pg-aiguide": {
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

也可以将其用作 Claude Code 插件：

claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide

按环境安装

claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide

codex mcp add --url "https://mcp.tigerdata.com/docs" pg-aiguide

{
  "mcpServers": {
    "pg-aiguide": {
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

gemini mcp add -s user pg-aiguide "https://mcp.tigerdata.com/docs" -t http

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

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

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

{
  "mcpServers": {
    "pg-aiguide": {
      "serverUrl": "https://mcp.tigerdata.com/docs"
    }
  }
}

💡 你的第一个提示词

安装后，pg-aiguide 可以回答 Postgres 相关问题或设计架构。

简单架构示例提示词

创建一个用于存储用户名和唯一电子邮件地址的 Postgres 表架构。

复杂架构示例提示词

你是一名资深软件工程师。现在需要为一家 IoT 设备公司生成一个 Postgres 架构。 这些设备会收集工厂车间的环境数据，包括温度、湿度、压力等主要数据点，以及因设备而异的其他测量值。每台设备都有唯一 ID 和易于识别的名称。我们还需要记录数据的采集时间。近期数据分析包括根据测量值查找离群值和异常情况，以及分析特定设备的数据以进行临时分析。历史数据分析包括分析单台设备的历史数据，或获取所有设备在较长时间范围内的统计数据。

功能

文档搜索（MCP 工具）

• search_docs 统一搜索工具，支持在多个文档来源中进行语义（向量相似度）和关键词（BM25）搜索：
  • postgres - 按版本分类的 PostgreSQL 官方手册
  • tiger - Tiger Data 的文档（TimescaleDB 及其生态系统）
  • postgis - PostGIS 空间扩展文档

技能（针对 AI 优化的最佳实践）

• view_skill
  提供经过整理、具有明确观点的 PostgreSQL 最佳实践技能，供 AI 编码助手自动使用。

  这些技能提供以下方面的指导：

  • 探索现有 PostgreSQL 架构和对象
  • 架构设计
  • 索引策略
  • 数据类型
  • 数据完整性和约束
  • 命名约定
  • 性能调优
  • PostgreSQL 现代功能

🔌 生态系统文档

目前支持：

• TimescaleDB（文档 + 技能）
• PostGIS（文档）

即将支持：

• pgvector

欢迎为其他扩展和工具贡献内容。

🛠 开发

请参阅 DEVELOPMENT.md，了解如何：

• 在本地运行 MCP 服务
• 添加新技能
• 添加新文档

🤝 贡献

欢迎贡献：

• PostgreSQL 最佳实践新技能
• 其他文档语料
• 搜索质量改进
• Bug 报告和功能构想

📄 许可证

Apache 2.0