/ 目录 / 演练场 / pg-aiguide
● 社区 timescale ⚡ 即开即用

pg-aiguide

作者 timescale · timescale/pg-aiguide

让编码 agent 具备 PostgreSQL 专业知识——官方文档的语义搜索加上精选的最佳实践。

Timescale 的 pg-aiguide 既是 Claude 插件也是 MCP server。它提供对 PostgreSQL/TimescaleDB/PostGIS 文档的语义搜索,以及精选的「技能」(schema 设计、索引、数据类型、性能优化)。据报道生成的 schema 中约束增加 4 倍,索引增加 55%。

为什么要用

核心特性

实时演示

实际使用效果

pg-aiguide.replay ▶ 就绪
0/0

安装

选择你的客户端

~/Library/Application Support/Claude/claude_desktop_config.json  · Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "pg-aiguide": {
      "command": "uvx",
      "args": [
        "pg-aiguide"
      ],
      "_inferred": true
    }
  }
}

打开 Claude Desktop → Settings → Developer → Edit Config。保存后重启应用。

~/.cursor/mcp.json · .cursor/mcp.json
{
  "mcpServers": {
    "pg-aiguide": {
      "command": "uvx",
      "args": [
        "pg-aiguide"
      ],
      "_inferred": true
    }
  }
}

Cursor 使用与 Claude Desktop 相同的 mcpServers 格式。项目级配置优先于全局。

VS Code → Cline → MCP Servers → Edit
{
  "mcpServers": {
    "pg-aiguide": {
      "command": "uvx",
      "args": [
        "pg-aiguide"
      ],
      "_inferred": true
    }
  }
}

点击 Cline 侧栏中的 MCP Servers 图标,然后选 "Edit Configuration"。

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "pg-aiguide": {
      "command": "uvx",
      "args": [
        "pg-aiguide"
      ],
      "_inferred": true
    }
  }
}

格式与 Claude Desktop 相同。重启 Windsurf 生效。

~/.continue/config.json
{
  "mcpServers": [
    {
      "name": "pg-aiguide",
      "command": "uvx",
      "args": [
        "pg-aiguide"
      ]
    }
  ]
}

Continue 使用服务器对象数组,而非映射。

~/.config/zed/settings.json
{
  "context_servers": {
    "pg-aiguide": {
      "command": {
        "path": "uvx",
        "args": [
          "pg-aiguide"
        ]
      }
    }
  }
}

加入 context_servers。Zed 保存后热重载。

claude mcp add pg-aiguide -- uvx pg-aiguide

一行命令搞定。用 claude mcp list 验证,claude mcp remove 卸载。

使用场景

实战用法: pg-aiguide

如何让 agent 编写生产级 Postgres schema

👤 正在启动新服务的后端工程师 ⏱ ~20 min intermediate

何时使用: 你想要的是能通过 code review 的 SQL。

前置条件
  • 添加 pg-aiguide MCP — 将客户端指向 https://mcp.tigerdata.com/docs 或安装 Claude 插件
步骤
  1. 陈述应用场景
    我需要一个多租户 SaaS 的 schema,包含 orgs、users、projects、invites。写 SQL 之前,先咨询 pg-aiguide 关于 schema 设计和标识符最佳实践。✓ 已复制
    → Agent 引用 view_skill 的输出
  2. 审查约束和索引
    给我看每个你添加的约束和原因。有冗余索引吗?✓ 已复制
    → 每个索引都有论证
  3. 检查现代特性
    用 search_docs 验证你用的是 GENERATED ALWAYS AS IDENTITY(不是 SERIAL),以及在适当的地方用 NULLS NOT DISTINCT。✓ 已复制
    → 应用了现代习语

结果: 有合理约束、正确的标识符列,以及你能论证的索引的 schema。

注意事项
  • Agent 滥用索引——写入密集的表会变慢 — 要求工作负载感知的索引——告诉它预期的读写比例
搭配使用: postgres

读 EXPLAIN 执行计划时如何获得专家级的上下文

👤 优化慢查询的开发者 ⏱ ~15 min intermediate

何时使用: 你有 EXPLAIN ANALYZE 的输出,但不知道什么是正常的。

步骤
  1. 分享执行计划
    [粘贴 EXPLAIN ANALYZE]——用 pg-aiguide 识别每个节点做什么,以及成本的典型原因。✓ 已复制
    → 逐节点诊断,引用文档
  2. 请求索引建议
    根据执行计划,建议修改一个索引。通过 pg-aiguide 验证索引类型(BTREE vs BRIN vs partial)。✓ 已复制
    → 具体的 CREATE INDEX 加上论证

结果: 理解了执行计划,用文档为修改辩护。

搭配使用: postgres

如何选择合适的 TimescaleDB hypertable 设置

👤 在 Postgres 上做时间序列的团队 ⏱ ~15 min advanced

何时使用: 新服务的第一个 hypertable——很多要调的参数。

步骤
  1. 说明摄入数据的形状
    我会每秒摄入约 10k 行物联网传感器数据,查询是过去 24 小时和过去 30 天的聚合。咨询 pg-aiguide 关于 TimescaleDB hypertable chunk interval 的建议。✓ 已复制
    → chunk interval 和压缩策略的原理
  2. 起草表
    起草 CREATE TABLE + create_hypertable + compression policy。✓ 已复制
    → 完整的 DDL

结果: 为你的摄入速率调优的 hypertable 配置。

搭配使用: postgres

组合

与其他 MCP 搭配,撬动十倍杠杆

pg-aiguide + postgres

咨询 pg-aiguide 获得最佳实践,然后通过 postgres MCP 实际应用

用 pg-aiguide 为 orders.user_id 选择合适的索引,然后通过 postgres MCP 在开发数据库上应用。显示修改前后的 EXPLAIN ANALYZE。✓ 已复制
pg-aiguide + github

用文档支持的推理来 code-review schema 迁移

审查添加新表的 PR #4421。用 pg-aiguide 标记任何偏离 PG 16 习语的选择。✓ 已复制

工具

此 MCP 暴露的能力

工具输入参数何时调用成本
search_docs query: str, product?: 'postgres'|'timescale'|'postgis', version?: str 查找特定的特性、函数或设置 free
view_skill skill: 'schema-design'|'indexing'|'data-types'|'performance' 在编写 schema 之前应用最佳实践指南 free

成本与限制

运行它的成本

API 配额
托管 endpoint——合理使用的速率限制
每次调用 Token 数
每个搜索结果 300-1500 tokens
费用
免费
提示
用 view_skill 获得宽泛的指导,只在需要具体引用时才用 search_docs。

安全

权限、密钥、影响范围

最小权限: 无——仅限文档
凭据存储:
数据出站: 你的查询会发送到 mcp.tigerdata.com
切勿授予: 无——无数据库访问权限

故障排查

常见错误与修复

search_docs 返回过时信息

固定版本:search_docs(query, version='17') 来获取 PG 17 的具体信息。

连接到 mcp.tigerdata.com 失败

检查公司防火墙;退回到 Claude 插件(本地)安装。

验证: curl -I https://mcp.tigerdata.com/docs
view_skill 返回通用输出

精确指定 skill slug——未知的 slug 会退回到通用摘要。

替代方案

pg-aiguide 对比其他方案

替代方案何时用它替代权衡
postgres MCP你需要执行 SQL,不仅仅是读文档没有精选的最佳实践层
Supabase MCPSupabase 特定的项目管理被 Supabase 锁定

更多

资源

📖 阅读 GitHub 上的官方 README

🐙 查看未解决的 issue

🔍 浏览全部 400+ MCP 服务器和 Skills