pg-aiguide MCP Server

chính thức

Kỹ năng và tài liệu Postgres giúp các công cụ mã hóa AI tạo mã PostgreSQL tốt hơn.

Tài liệu

pg-aiguide

Chuyên môn PostgreSQL được tối ưu 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 trên toàn bộ tài liệu hướng dẫn chính thức của PostgreSQL (có nhận biết phiên bản)
  • “Kỹ năng” được tối ưu cho AI — các thực hành tốt nhất về Postgres được tuyển chọn, có chính 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ẽ sớm có thêm nhiều tài liệu khác

Sử dụng nó như:

  • Kỹ năng tác nhân 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 ra mã Postgres:

  • lỗi thời
  • thiếu ràng buộc và chỉ mục
  • không biết đến các tính năng PG hiện đại
  • không nhất quán với các thực hành tốt 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 sâu, theo phiên bản 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ản ghi Video

Lời nhắc được đưa cho Claude Code:

Vui lòng mô tả lược đồ bạn sẽ tạo cho một trang web thương mại điện tử hai lần, lần đầu khi máy chủ tiger mcp bị tắt, sau đó là khi máy chủ tiger mcp được bật. Đối với mỗi lần, hãy ghi lược đồ vào tệp riêng trong thư mục làm việc hiện tại. Sau đó so sánh hai tệp và cho tôi biết cách tiếp cận nào tạo ra lược đồ tốt hơn, sử dụng cả lý do định tính và định lượng. Đối với ví dụ này, chỉ sử dụng Postgres tiêu chuẩn.

Kết quả (tóm tắt):

  • Nhiều ràng buộc hơn gấp 4 lần
  • Nhiều chỉ mục hơn 55% (bao gồm chỉ mục một phần/biểu thức)
  • Các mẫu được khuyến nghị cho PG17
  • Các tính năng hiện đại (GENERATED ALWAYS AS IDENTITY, NULLS NOT DISTINCT)
  • Đặt tên & tài liệu rõ ràng hơn

Kết luận: pg-aiguide tạo ra các lược đồ mạnh mẽ, hiệu suất cao và dễ bảo trì hơn.

🚀 Bắt đầu nhanh

Kỹ năng tác nhân

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 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, hãy thêm máy chủ MCP để cung cấp cho tác nhân của bạn khả năng tìm kiếm ngữ nghĩa trên các tài liệu hướng dẫn chính thức của PostgreSQL, TimescaleDB và PostGIS.

Máy chủ MCP

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

https://mcp.tigerdata.com/docs

Cấu hình MCP thủ công bằng JSON
{
  "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

Install in Cursor Install in VS Code Install in VS Code Insiders Install in Visual Studio Install in Goose Add MCP Server pg-aiguide to LM Studio

Claude Code

Repo này phục vụ như một plugin marketplace của claude code. Để cài đặt, chạy:

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

Plugin này sử dụng các kỹ năng có sẵn trong thư mục skills cũng như điểm cuối máy chủ MCP công khai của chúng tôi được lưu trữ bởi TigerData để tìm kiếm tài liệu PostgreSQL.

Codex

Chạy lệnh sau để thêm máy chủ MCP vào codex:

codex mcp add --url "https://mcp.tigerdata.com/docs" pg-aiguide
Cursor

Cài đặt một cú nhấp chuột:

Install MCP Server

Hoặc thêm phần sau vào .cursor/mcp.json

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

Chạy lệnh sau để thêm máy chủ MCP vào Gemini CLI:

gemini mcp add -s user pg-aiguide "https://mcp.tigerdata.com/docs" -t http
Visual Studio

Nhấp vào nút để cài đặt:

Install in Visual Studio

VS Code

Nhấp vào nút để cài đặt:

Install in VS Code

Ngoài ra, chạy lệnh sau để thêm máy chủ MCP vào VS Code:

code --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'
VS Code Insiders

Nhấp vào nút để cài đặt:

Install in VS Code Insiders

Ngoài ra, chạy lệnh sau để thêm máy chủ MCP vào VS Code Insiders:

code-insiders --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'
Windsurf

Thêm phần sau vào ~/.codeium/windsurf/mcp_config.json

{
  "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 một 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 cao cấp. Bạn được giao nhiệm vụ tạo một 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, là 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 mà con người có thể đọc được. 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 hợp nhất hỗ trợ tìm kiếm ngữ nghĩa (tương đồng vector) và từ khóa (BM25) trên nhiều nguồn tài liệu:
    • postgres - Tài liệu hướng dẫn chính thức của PostgreSQL, được giới hạn 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 (Thực hành tốt nhất được tối ưu 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ính 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ề:

    • Thiết kế lược đồ
    • Chiến lược lập chỉ mục
    • Kiểu dữ liệu
    • Tính toàn vẹn dữ liệu và ràng buộc
    • Quy ước đặt tên
    • Tinh 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 nay:

  • 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 mới về Postgres
  • 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