OpenAPI Schema MCP Server

OpenAPI Schema MCP Server làm gì?

OpenAPI Schema MCP Server là một máy chủ Model Context Protocol (MCP) được thiết kế để cung cấp thông tin schema OpenAPI cho các Mô hình Ngôn ngữ Lớn (LLM) như Claude. Thông qua việc cung cấp truy cập có cấu trúc tới các đặc tả OpenAPI, server này giúp trợ lý AI khám phá và hiểu API, bao gồm các endpoint, tham số, schema yêu cầu và phản hồi cùng nhiều thông tin khác. Điều này giúp các nhà phát triển và công cụ AI truy vấn cấu trúc API, tìm kiếm trong nhiều đặc tả và truy xuất chi tiết schema, từ đó nâng cao quy trình tích hợp API, tài liệu hóa và sinh mã. Server hỗ trợ nạp file OpenAPI ở định dạng JSON hoặc YAML và trả về kết quả ở YAML để tăng khả năng hiểu cho LLM.

Danh sách Prompt

Không có template prompt rõ ràng nào được ghi nhận trong kho lưu trữ.

Danh sách Resource

Không có resource nào được mô tả rõ ràng trong kho lưu trữ.

Danh sách Công cụ

OpenAPI Schema MCP Server cung cấp các công cụ sau cho LLM:

• list-endpoints: Liệt kê tất cả các đường dẫn API và phương thức HTTP kèm tóm tắt trong cấu trúc đối tượng lồng nhau.
• get-endpoint: Truy xuất thông tin chi tiết về một endpoint cụ thể, bao gồm tham số và phản hồi.
• get-request-body: Cung cấp schema phần thân yêu cầu cho endpoint và phương thức HTTP xác định.
• get-response-schema: Trả về schema phản hồi cho endpoint, phương thức và mã trạng thái xác định.
• get-path-parameters: Lấy tham số cho đường dẫn cụ thể.
• list-components: Liệt kê tất cả các thành phần schema (schemas, responses, parameters, v.v.).
• get-component: Trả về định nghĩa chi tiết cho một component cụ thể.
• list-security-schemes: Liệt kê tất cả các scheme bảo mật có trong API.
• get-examples: Truy xuất các ví dụ cho component hoặc endpoint cụ thể.
• search-schema: Tìm kiếm trên các đường dẫn, thao tác và schema trong đặc tả OpenAPI.

Các trường hợp sử dụng MCP Server này

• Khám phá và Tài liệu hóa API: Nhà phát triển hoặc LLM có thể nhanh chóng liệt kê endpoint, tham số và schema, giúp việc tài liệu hóa hoặc hiểu cấu trúc API dễ dàng hơn.
• Sinh mã tự động: Thông qua việc truy xuất lập trình các schema yêu cầu và phản hồi, các công cụ có thể sinh thư viện client hoặc đoạn mã cho tương tác API.
• Kiểm thử và xác thực API: Các công cụ kiểm thử có thể dùng server này để lấy tham số và payload mẫu, hỗ trợ kiểm thử API tự động hoặc thủ công.
• Rà soát bảo mật: Phân tích các scheme bảo mật và cách triển khai chúng trên các endpoint để đảm bảo API được bảo vệ đúng cách.
• Tìm kiếm và phân tích schema: Nhanh chóng tìm và phân tích các thành phần schema hoặc endpoint liên quan tới một thực thể hoặc tính năng cụ thể trong các đặc tả API lớn.

Hướng dẫn thiết lập

Windsurf

Không có hướng dẫn thiết lập cho Windsurf.

Claude

1. Đảm bảo Node.js và npx đã được cài đặt.
2. Xác định vị trí file cấu hình Claude Desktop của bạn:
   • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: $env:AppData\Claude\claude_desktop_config.json
3. Thêm OpenAPI Schema MCP server vào đối tượng mcpServers:

   {
     "mcpServers": {
       "OpenAPI Schema": {
         "command": "npx",
         "args": ["-y", "mcp-openapi-schema", "/ABSOLUTE/PATH/TO/openapi.yaml"]
       }
     }
   }
   

4. Lưu file và khởi động lại Claude Desktop.
5. Kiểm tra server đã sẵn sàng trong giao diện Claude của bạn.

Cursor

Không có hướng dẫn thiết lập cho Cursor.

Cline

Claude Code CLI

1. Đảm bảo Node.js và npx đã được cài đặt.
2. Thêm OpenAPI Schema MCP server:

   claude mcp add openapi-schema npx -y mcp-openapi-schema
   

   Hoặc với file schema cụ thể:

   claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml
   

3. Kiểm tra đăng ký:

   claude mcp list
   claude mcp get openapi-schema
   

4. Tùy chọn, xóa server:

   claude mcp remove openapi-schema
   

5. Sử dụng các công cụ trong phiên Claude Code của bạn.

Bảo mật API Key

Không có thông tin về bảo mật API key hoặc sử dụng biến môi trường.

Cách sử dụng MCP trong luồng FlowHunt

Sử dụng MCP trong FlowHunt

Để tích hợp MCP server vào quy trình FlowHunt của bạn, hãy bắt đầu bằng cách thêm thành phần MCP vào luồng và kết nối nó với AI agent:

Nhấn vào thành phần MCP để mở bảng cấu hình. Trong phần cấu hình hệ thống MCP, thêm thông tin server MCP của bạn theo định dạng JSON sau:

{
  "MCP-name": {
    "transport": "streamable_http",
    "url": "https://yourmcpserver.example/pathtothemcp/url"
  }
}

Sau khi cấu hình, AI agent đã có thể sử dụng MCP này như một công cụ với đầy đủ chức năng và khả năng của nó. Lưu ý thay “MCP-name” bằng tên thực tế của MCP server bạn (ví dụ: “github-mcp”, “weather-api”, v.v.) và thay thế URL bằng địa chỉ MCP server của bạn.

Tổng quan

Dựa trên tài liệu hiện có, OpenAPI Schema MCP Server được chuyên môn hóa cao cho việc khám phá OpenAPI qua LLM, cung cấp bộ công cụ mạnh nhưng thiếu chi tiết về prompt, resource, xử lý API key và các tính năng nâng cao của MCP. Cho các trường hợp sử dụng OpenAPI, nó rất tốt; cho các tính năng MCP mở rộng, nó còn hạn chế.

Điểm MCP

Đánh giá:
Tôi đánh giá MCP server này 6/10. Mặc dù nó được định nghĩa tốt cho khám phá schema OpenAPI và cung cấp bộ công cụ mạnh, nó thiếu tài liệu về template prompt MCP, định nghĩa resource rõ ràng, thực hành bảo mật và không đề cập hỗ trợ roots hoặc sampling. Việc không có LICENSE cũng là một hạn chế lớn cho hợp tác mở.