Kết nối tài liệu đã xuất bản với AI

Apidog MCP Server cho phép AI kết nối và sử dụng tài liệu API trực tuyến được Apidog xuất bản, giúp các nhà phát triển bên ngoài và trợ lý AI truy cập tài liệu API công khai một cách liền mạch.

Phương pháp cấu hình này chỉ hỗ trợ tài liệu trực tuyến được xuất bản công khai. Phương pháp này không hỗ trợ tài liệu có thiết lập mật khẩu hoặc allowlist.

Đối với tài liệu không công khai, hãy sử dụng nguồn dữ liệu Dự án Apidog thay thế.

Bật MCP cho tài liệu trực tuyến

Yêu cầu Apidog phiên bản 2.7.2 trở lên.

Bật dịch vụ MCP

Điều hướng đến dự án Apidog của bạn

Đi tới Publish Docs → Publish Docs Sites → LLM-friendly Features

Bật dịch vụ MCP

Lấy tệp cấu hình

Sau khi bật MCP, nút MCP sẽ xuất hiện khi truy cập tài liệu trực tuyến của bạn.

Nhấp vào nút để hiển thị hướng dẫn cấu hình và tệp cấu hình MCP, trong đó tự động bao gồm site-id của tài liệu của bạn. Sao chép cấu hình này để tích hợp với IDE.

Cấu hình MCP Client

Điều kiện tiên quyết

Trước khi cấu hình MCP client, hãy đảm bảo bạn có:

Node.js (phiên bản 18 trở lên, tốt nhất là phiên bản LTS mới nhất)

Một IDE tương thích với MCP:

Cursor

VS Code + plugin Cline

Các trình soạn thảo khác hỗ trợ MCP

Cấu hình MCP JSON đã sao chép từ tài liệu trực tuyến của Apidog

Cấu hình MCP trong Cursor

Mở phần cài đặt MCP

Mở trình soạn thảo Cursor

Nhấp vào biểu tượng cài đặt (góc trên bên phải)

Chọn MCP từ menu bên trái

Nhấp vào + Add new global MCP server

Thêm cấu hình

Dán cấu hình MCP JSON đã sao chép từ tài liệu trực tuyến vào tệp mcp.json đã mở:

macOS / Linux

Windows

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Xác minh cấu hình

Kiểm thử kết nối bằng cách hỏi AI (ở chế độ Agent):

Please fetch API documentation via MCP and tell me how many endpoints exist in the project.

Nếu AI trả về thông tin API chính xác, kết nối đã thành công.

Ghi chú quan trọng

Làm việc với nhiều trang tài liệu

Để làm việc với các trang tài liệu API khác nhau, hãy thêm nhiều cấu hình MCP Server vào tệp cấu hình. Mỗi trang tài liệu nên có một <site-id> duy nhất của riêng mình.

Triển khai On-Premise

Đối với các triển khai on-premise, hãy bao gồm địa chỉ API của server của bạn trong cấu hình MCP của IDE:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

Thay thế <your-server-url> bằng địa chỉ API của server on-premise của bạn (bắt đầu bằng http:// hoặc https://). Đảm bảo có quyền truy cập mạng đến www.npmjs.com.

Các nguồn dữ liệu khác

Kết nối đặc tả API trong Dự án Apidog với AI

Kết nối tệp OpenAPI với AI

Câu hỏi thường gặp

Sự cố cấu hình trên Windows

Nếu cấu hình tiêu chuẩn không thành công trên Windows, hãy sử dụng phương án thay thế này:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Sự cố phiên bản Node.js

Làm thế nào để AI đọc dữ liệu mới nhất từ tài liệu API đã cập nhật?

Kết nối tài liệu đã xuất bản với AI

Bật MCP cho tài liệu trực tuyến#

Cấu hình MCP Client#

Điều kiện tiên quyết#

Cấu hình MCP trong Cursor#

Ghi chú quan trọng#

Làm việc với nhiều trang tài liệu#

Triển khai On-Premise#

Các nguồn dữ liệu khác#

Câu hỏi thường gặp#

Bật MCP cho tài liệu trực tuyến

Cấu hình MCP Client

Điều kiện tiên quyết

Cấu hình MCP trong Cursor

Ghi chú quan trọng

Làm việc với nhiều trang tài liệu

Triển khai On-Premise

Các nguồn dữ liệu khác

Câu hỏi thường gặp