pg-aiguide

pg-aiguide

面向 AI 优化的 PostgreSQL 专业知识，专为编码助手打造

pg-aiguide 帮助 AI 编码工具编写出质量显著更高的 PostgreSQL 代码。它提供：

• 语义搜索，覆盖官方 PostgreSQL 手册（支持版本感知）
• AI 优化的“技能” —— 经过精选和提炼的 Postgres 最佳实践，AI 代理可自动使用
• 扩展生态文档，从 TimescaleDB 开始，更多扩展即将推出

可通过以下方式使用：

• 通过 npx skills 作为 Agent 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

🚀 快速开始

Agent Skills

为您的 AI 编码代理安装精选的 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 多种其他代理。

如需更深入的 PostgreSQL 知识，还可以添加 MCP 服务器，让您的代理能够对官方 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 表模式，用于存储用户名和唯一的电子邮件地址。

复杂模式示例提示

您是一名高级软件工程师。您的任务是为一家物联网设备公司生成 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 服务器
• 添加新技能
• 添加新文档

🤝 贡献

我们欢迎：

• 新的 Postgres 最佳实践技能
• 额外的文档语料库
• 搜索质量改进
• 错误报告和功能建议

📄 许可证

Apache 2.0