项目介绍
pg-aiguide 是 Timescale 组织维护的 PostgreSQL Agent 扩展。它把可本地加载的数据库最佳实践 Skills,与 Tiger Data 托管的文档搜索 MCP 组合在一起。用户可以只安装 PostgreSQL Skill,也可以在 Claude Code 中安装完整插件,或把 MCP 端点单独接入 Codex 等客户端。它的强项不是代替数据库,而是让 Agent 在设计表、选择索引、规划迁移或查版本差异时先引用更具体的 PostgreSQL、TimescaleDB 与 PostGIS资料。
核心功能
版本感知的 PostgreSQL 文档检索
search_docs 要求选择明确的文档源,可区分 PostgreSQL 14 至 18、PostGIS 3.3 至 3.6,以及 Tiger Data 文档。
语义、关键词和混合搜索
semanticWeight 为 0 时使用 BM25,设为 1 时使用语义向量,中间值并行检索后用 RRF 融合排名。
数据库专项 Skills
postgres Skill 会按任务路由到表设计、PostGIS、pgvector、混合搜索、hypertable 与安全迁移等参考材料。
多种 Agent 接入方式
仓库分别提供 Claude Code marketplace、npx skills、Codex MCP 与多款编辑器的安装或配置入口。
安装与使用
Claude Code 用户可先添加 timescale/pg-aiguide marketplace,再安装 pg@aiguide;该插件会加载本地数据库 Skills,并连接 Tiger Data 的托管文档检索 MCP。
让 AI Agent 帮你安装
把这段话发送给 Codex、Claude Code 或其他可以操作本地环境的 AI Agent。
请帮我安装 pg-aiguide。项目地址:https://github.com/timescale/pg-aiguide。先阅读 README.md、.claude-plugin/marketplace.json、skills/postgres/SKILL.md、API.md 和 LICENSE,确认当前使用 Claude Code,且允许访问 GitHub 与 https://mcp.tigerdata.com/docs。明确提醒我:托管检索会把查询发送给 Tiger Data;语义或混合查询按源码还会在服务端使用 OpenAI 嵌入。得到确认后,严格按仓库文档依次执行 claude plugin marketplace add timescale/pg-aiguide 和 claude plugin install pg@aiguide。安装后检查 pg@aiguide 与 search_docs 是否可见,再用不含凭据或业务敏感信息的 PostgreSQL 文档问题做最小验证。请报告安装结果、修改的配置、可见工具和未验证项;如需凭据、数据库连接、覆盖配置、自托管、执行 SQL 或扩大权限,必须先征得我的确认。- 已安装支持插件市场的 Claude Code
- 能够访问 GitHub 与 https://mcp.tigerdata.com/docs
- 确认项目允许把文档检索词发送给外部托管服务
claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide- 1确认数据边界
先确认环境允许访问 mcp.tigerdata.com,并约定检索词不得包含凭据、私有 SQL 或业务数据。若不接受托管服务,改为评估自托管,不要继续默认安装。
- 2添加插件市场
在 Claude Code 中执行 claude plugin marketplace add timescale/pg-aiguide,添加仓库声明的 aiguide marketplace。
- 3安装 pg 插件
执行 claude plugin install pg@aiguide。插件清单会组合仓库 Skills 与禁用 MCP Skills 的托管搜索端点,避免重复暴露 Skills。
- 4检查能力并做无敏感数据验证
确认 postgres Skill 与 search_docs 可见,再提出一个带明确 PostgreSQL 版本的公开文档问题。检查结果是否包含内容和元数据,不要在测试查询中放入项目机密。
执行两条安装命令后,在 Claude Code 中检查 pg@aiguide 已启用,并确认 pg-aiguide MCP 的 search_docs 工具可见。用不含敏感信息的问题检索一个明确版本的 PostgreSQL 文档;只有工具返回带内容与元数据的结果,才算最小功能验证通过。
- 本页核验时发布版为 v0.6.1,但仓库内 serverInfo 仍写 1.0.0;记录两个版本,不要据此自动升级或降级。
- 若只需要本地知识,可先安装 postgres Skill;需要官方文档检索时再接入 MCP。
- 不要把数据库密码、连接串、客户数据或私有 SQL 粘贴到托管检索查询中。
- 自托管需要额外准备 pgvector 数据库、文档摄取流程和 OpenAI API Key。
使用场景
设计 PostgreSQL 表与索引
让 Agent 先加载表设计参考,再结合版本化官方文档检查数据类型、约束、索引和分区选择。
规划低风险数据库迁移
使用迁移 Skill 组织锁等待、超时、回滚和分阶段验证,但生产执行仍需数据库负责人确认。
核对 pgvector、PostGIS 与 TimescaleDB 用法
按专项 Skill 获取设计模式,再用文档检索核对具体扩展和版本的语法或限制。
使用评价
pg-aiguide 的价值在于把数据库专项实践与版本化文档检索放进同一扩展,接入路径也覆盖 Claude Code、Codex 和通用 Agent Skills。它适合辅助设计与查证,不应被当作自动修改生产库的授权。采用前最需要确认的是托管查询边界、缺少仓库安全策略,以及自托管所需的数据库和嵌入基础设施。
值得一试的地方
- 由 Timescale 组织维护,许可证、插件清单、API 和自托管文档齐全。
- 同时覆盖 PostgreSQL、TimescaleDB、PostGIS,并区分多个文档版本。
- 支持关键词、语义与混合检索,数据库 Skills 的任务划分具体。
- 近期有版本发布、提交和成功的测试与 lint 工作流。
使用前要知道
- 托管检索涉及 Tiger Data,并可能进一步调用 OpenAI 嵌入服务。
- 仓库未提供 SECURITY.md,且运行时服务版本与发布版本存在元数据差异。
- 自托管需要自行准备数据库、文档摄取和嵌入服务,运维成本明显高于直接接入。
- 本次没有执行安装、MCP 调用或真实数据库场景测试。
README
pg-aiguide
Overview
Timescale 维护的 PostgreSQL Agent 扩展,组合本地最佳实践 Skills 与托管 MCP 文档检索,覆盖 PostgreSQL、TimescaleDB 和 PostGIS。 MCP server and Claude plugin for Postgres skills and documentation. Helps AI coding tools generate better PostgreSQL code.
Getting started
- Claude Code 用户可先添加 timescale/pg-aiguide marketplace,再安装 pg@aiguide;该插件会加载本地数据库 Skills,并连接 Tiger Data 的托管文档检索 MCP。
- Agent Skills 路径提供 PostgreSQL 表设计、PostGIS、pgvector、混合搜索、TimescaleDB hypertable 和迁移等专项参考。
- MCP 的 search_docs 工具可搜索 PostgreSQL 14–18、PostGIS 3.3–3.6 及 Tiger Data 文档,并用 semanticWeight 选择关键词、语义或混合模式。
- 执行两条安装命令后,在 Claude Code 中检查 pg@aiguide 已启用,并确认 pg-aiguide MCP 的 search_docs 工具可见。用不含敏感信息的问题检索一个明确版本的 PostgreSQL 文档;只有工具返回带内容与元数据的结果,才算最小功能验证通过。
Configuration
claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide在 GitHub 阅读完整 README →