pg-aiguide

pg-aiguide

Kiến thức chuyên sâu về PostgreSQL được tối ưu hóa cho AI dành cho trợ lý lập trình

pg-aiguide giúp các công cụ lập trình AI viết mã PostgreSQL tốt hơn đáng kể. Nó cung cấp:

• Tìm kiếm ngữ nghĩa trong toàn bộ tài liệu chính thức của PostgreSQL (nhận biết phiên bản)
• "Kỹ năng" tối ưu hóa cho AI — các phương pháp hay nhất về Postgres được tuyển chọn, có chủ kiến, được các tác nhân AI tự động sử dụng
• Tài liệu hệ sinh thái mở rộng, bắt đầu với TimescaleDB, và sắp có thêm nhiều tài liệu khác

Sử dụng nó như:

• Kỹ năng tác nhân (Agent Skills) qua npx skills — hoạt động với Claude Code, Cursor, Codex, Gemini CLI và hơn 40 tác nhân khác
• một máy chủ MCP công khai có thể được sử dụng với bất kỳ tác nhân lập trình AI nào, hoặc
• một plugin Claude Code được tối ưu hóa để sử dụng với hỗ trợ kỹ năng gốc của Claude.

⭐ Tại sao chọn pg-aiguide?

Các công cụ lập trình AI thường tạo mã Postgres:

• lỗi thời
• thiếu ràng buộc và chỉ mục
• không nhận biết các tính năng PG hiện đại
• không nhất quán với các phương pháp hay nhất trong thực tế

pg-aiguide khắc phục điều đó bằng cách cung cấp cho các tác nhân AI kiến thức PostgreSQL phiên bản hóa sâu sắc và các mẫu đã được chứng minh.

Xem sự khác biệt

https://github.com/user-attachments/assets/5a426381-09b5-4635-9050-f55422253a3d

🚀 Bắt đầu nhanh

Kỹ năng tác nhân (Agent Skills)

Cài đặt các kỹ năng thực hành tốt nhất về PostgreSQL đã được tuyển chọn cho tác nhân lập trình AI của bạn:

npx skills add timescale/pg-aiguide --skill postgres

Hoặc cài đặt kỹ năng khám phá lược đồ để điều tra một cơ sở dữ liệu PostgreSQL hiện có:

npx skills add timescale/pg-aiguide --skill schema-exploration

Hoặc chọn từng kỹ năng riêng lẻ một cách tương tác:

npx skills add timescale/pg-aiguide

Hoạt động với Claude Code, Cursor, Codex, Gemini CLI, VS Code và hơn 40 tác nhân khác.

Để có kiến thức PostgreSQL sâu hơn nữa, cũng hãy thêm máy chủ MCP để cung cấp cho tác nhân của bạn tìm kiếm ngữ nghĩa trong các tài liệu chính thức của PostgreSQL, TimescaleDB và PostGIS.

Máy chủ MCP

Để tìm kiếm ngữ nghĩa trong tài liệu PostgreSQL, TimescaleDB và PostGIS, hãy thêm máy chủ MCP công khai:

https://mcp.tigerdata.com/docs

{
  "mcpServers": {
    "pg-aiguide": {
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

Hoặc nó có thể được sử dụng như một Plugin Claude Code:

claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide

Cài đặt theo môi trường

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"
    }
  }
}

💡 Lời nhắc đầu tiên của bạn

Sau khi cài đặt, pg-aiguide có thể trả lời các câu hỏi về Postgres hoặc thiết kế lược đồ.

Ví dụ lời nhắc lược đồ đơn giản

Tạo lược đồ bảng Postgres để lưu trữ tên người dùng và địa chỉ email duy nhất.

Ví dụ lời nhắc lược đồ phức tạp

Bạn là một kỹ sư phần mềm cấp cao. Bạn được giao nhiệm vụ tạo lược đồ Postgres cho một công ty thiết bị IoT. Các thiết bị thu thập dữ liệu môi trường trên sàn nhà máy. Dữ liệu bao gồm nhiệt độ, độ ẩm, áp suất, như các điểm dữ liệu chính cũng như các phép đo khác thay đổi tùy theo từng thiết bị. Mỗi thiết bị có một id duy nhất và một tên dễ đọc cho con người. Chúng tôi cũng muốn ghi lại thời gian dữ liệu được thu thập. Phân tích dữ liệu gần đây bao gồm tìm các giá trị ngoại lệ và bất thường dựa trên các phép đo, cũng như phân tích dữ liệu của các thiết bị cụ thể để phân tích đặc biệt. Phân tích dữ liệu lịch sử bao gồm phân tích lịch sử dữ liệu cho một thiết bị hoặc lấy số liệu thống kê cho tất cả các thiết bị trong khoảng thời gian dài.

Tính năng

Tìm kiếm tài liệu (Công cụ MCP)

• search_docs Công cụ tìm kiếm thống nhất hỗ trợ tìm kiếm ngữ nghĩa (tương tự vector) và tìm kiếm từ khóa (BM25) trên nhiều nguồn tài liệu:
  • postgres - Tài liệu chính thức của PostgreSQL, được phạm vi theo phiên bản
  • tiger - Tài liệu của Tiger Data (TimescaleDB và hệ sinh thái)
  • postgis - Tài liệu mở rộng không gian PostGIS

Kỹ năng (Các phương pháp hay nhất được tối ưu hóa cho AI)

• view_skill
  Cung cấp các kỹ năng thực hành tốt nhất về PostgreSQL được tuyển chọn, có chủ kiến, được các trợ lý lập trình AI tự động sử dụng.

  Các kỹ năng này cung cấp hướng dẫn về:

  • Khám phá các lược đồ và đối tượng PostgreSQL hiện có
  • Thiết kế lược đồ
  • Chiến lược lập chỉ mục
  • Các loại dữ liệu
  • Tính toàn vẹn và ràng buộc dữ liệu
  • Quy ước đặt tên
  • Điều chỉnh hiệu suất
  • Các tính năng PostgreSQL hiện đại

🔌 Tài liệu hệ sinh thái

Được hỗ trợ hiện tại:

• TimescaleDB (tài liệu + kỹ năng)
• PostGIS (tài liệu)

Sắp ra mắt:

• pgvector

Chúng tôi hoan nghênh các đóng góp cho các tiện ích mở rộng và công cụ bổ sung.

🛠 Phát triển

Xem DEVELOPMENT.md để biết:

• chạy máy chủ MCP cục bộ
• thêm kỹ năng mới
• thêm tài liệu mới

🤝 Đóng góp

Chúng tôi hoan nghênh:

• các kỹ năng thực hành tốt nhất về Postgres mới
• các kho tài liệu bổ sung
• cải thiện chất lượng tìm kiếm
• báo cáo lỗi và ý tưởng tính năng

📄 Giấy phép

Apache 2.0