pg-aiguide

🚀 pg-aiguide

pg-aiguide 为代码编写助手提供经过 AI 优化的 PostgreSQL 专业知识。它能显著提升 AI 编码工具编写 PostgreSQL 代码的质量，主要功能包括：

• 语义搜索：可对官方 PostgreSQL 手册进行语义搜索（支持版本识别）。
• AI 优化“技能”：精心整理、专业权威的 Postgres 最佳实践，能被 AI 智能体自动运用。
• 扩展生态文档：目前已涵盖 TimescaleDB，更多扩展即将推出。

它支持以下两种使用方式：

• 公共 MCP 服务器：可与任何 AI 编码智能体配合使用。
• Claude Code 插件：针对 Claude 的原生技能支持进行了优化。

🚀 快速开始

pg-aiguide 作为公共 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

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 工具）

• semantic_search_postgres_docs
  可对官方 PostgreSQL 手册进行语义搜索，搜索结果会根据特定的 Postgres 版本进行筛选。

• semantic_search_tiger_docs 可搜索 Tiger Data 的文档语料库，包括 TimescaleDB 以及未来的生态系统扩展。

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

• view_skill
  提供精心整理、专业权威的 PostgreSQL 最佳实践技能，供 AI 编码助手自动使用。

  这些技能涵盖以下方面的指导：

  • 模式设计
  • 索引策略
  • 数据类型
  • 数据完整性和约束
  • 命名约定
  • 性能调优
  • 现代 PostgreSQL 特性

📚 详细文档

🔌 生态系统文档

目前支持：

• TimescaleDB（文档 + 技能）

即将支持：

• pgvector
• PostGIS

我们欢迎为更多扩展和工具做出贡献。

🛠 开发相关

如需了解以下内容，请参阅 DEVELOPMENT.md：

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

🤝 贡献指南

我们欢迎以下方面的贡献：

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

📄 许可证

本项目采用 Apache 2.0 许可证。