pg-aiguide项目结构解析：源码目录、技能系统和配置文件的组织

【免费下载链接】pg-aiguide MCP server and Claude plugin for Postgres skills and documentation. Helps AI coding tools generate better PostgreSQL code. 项目地址: https://gitcode.com/GitHub_Trending/pg/pg-aiguide

pg-aiguide是一个专为AI编程工具优化的PostgreSQL技能和文档MCP服务器，通过语义搜索和精心设计的技能系统，帮助AI助手生成更高质量的PostgreSQL代码。🎯

📁 项目整体架构概览

pg-aiguide采用了清晰的分层架构设计，主要包含以下几个核心目录：

源码目录结构

• src/ - 核心源码目录
• skills/ - AI优化技能系统
• migrations/ - 数据库迁移文件
• ingest/ - 文档数据处理模块
• docker/ - Docker容器化配置

🔧 核心源码模块详解

API接口层 (src/apis/)

项目的主要功能通过API接口层实现，包含多个语义搜索工具：

• semanticSearchPostgresDocs - PostgreSQL官方文档语义搜索
• semanticSearchTigerDocs - Tiger Data文档语料库搜索
• keywordSearchTigerDocs - 关键词搜索功能
• view_skill - 技能查看工具

这些API工厂函数在 src/apis/index.ts 中统一导出，支持版本感知的文档搜索。

技能系统 (skills/)

pg-aiguide的技能系统是其核心价值所在，包含多个专门优化的PostgreSQL最佳实践：

• design-postgres-tables/ - 表设计技能
• find-hypertable-candidates/ - 超表候选识别
• `migrate-postgres-tables-to-hypertables/ - 表迁移到超表
• setup-timescaledb-hypertables/ - TimescaleDB超表设置

每个技能目录都包含详细的 SKILL.md 文件，为AI助手提供具体的操作指导。

⚙️ 配置与依赖管理

项目配置

• package.json - 定义项目元数据和依赖
• skills.yaml - 技能系统配置
• biome.json - 代码格式化配置
• tsconfig.json - TypeScript编译配置

数据库配置

数据库架构配置在 src/config.ts 中，默认使用 docs 模式。

🚀 快速开始与部署

项目支持多种部署方式：

• 公共MCP服务器 - 通过 https://mcp.tigerdata.com/docs 访问
• Claude Code插件 - 专门为Claude优化的技能支持

开发环境搭建

通过 docker-compose.yml 可以快速启动本地开发环境，数据库初始化脚本位于 docker/tsdb/100_setup_db.sql。

💡 技术特色与优势

pg-aiguide通过以下方式显著提升AI生成的PostgreSQL代码质量：

• 语义搜索能力 - 支持版本感知的PostgreSQL文档搜索
• AI优化技能 - 精心设计的PostgreSQL最佳实践
• 扩展生态系统 - 支持TimescaleDB等扩展工具
• 约束和索引优化 - 自动生成包含完整约束和索引的健壮模式

📊 实际效果对比

实际测试表明，启用pg-aiguide后：

• 约束数量增加4倍
• 索引数量增加55%
• 采用PostgreSQL 17推荐模式
• 使用现代特性如 GENERATED ALWAYS AS IDENTITY

🔮 未来发展路线

项目正在持续扩展生态系统支持：

• pgvector - 向量搜索扩展
• PostGIS - 地理空间数据处理

pg-aiguide的项目结构设计体现了现代软件开发的最佳实践，通过清晰的模块划分和专业的技能系统，为AI编程工具提供了强大的PostgreSQL支持能力。✨

【免费下载链接】pg-aiguide MCP server and Claude plugin for Postgres skills and documentation. Helps AI coding tools generate better PostgreSQL code. 项目地址: https://gitcode.com/GitHub_Trending/pg/pg-aiguide