@reapi/mcp 開放API

什麼是 MCP OpenAPI？

MCP OpenAPI 是一個開源項目，提供 MCP（多通道協議）伺服器的規範。它允許開發者以標準化的格式定義和記錄 API，使不同系統和服務的整合變得更容易。MCP OpenAPI 規範旨在增強互操作性，並簡化依賴多通道通信的應用程序的開發過程。

MCP OpenAPI 的特點

• 標準化的 API 文檔：MCP OpenAPI 提供了一種清晰簡潔的方式來記錄 API，確保開發者能夠輕鬆理解如何與各種服務互動。
• 互操作性：通過遵循 OpenAPI 規範，MCP OpenAPI 促進了不同系統之間的無縫通信，無論其底層技術如何。
• 開源：作為一個開源項目，MCP OpenAPI 鼓勵社區貢獻，允許開發者增強和擴展其功能。
• 友好的用戶界面：該項目為開發者提供了一個友好的界面來創建、管理和測試 API，減少了與 API 開發相關的學習曲線。

如何使用 MCP OpenAPI

1. 安裝：首先從 GitHub 克隆 MCP OpenAPI 倉庫。您可以使用以下命令進行操作：

   git clone https://github.com/ReAPI-com/mcp-openapi.git
   

2. 定義您的 API：創建一個 OpenAPI 規範文件（通常為 YAML 或 JSON 格式），概述您的 API 的端點、請求/響應格式和身份驗證方法。
3. 生成文檔：使用 Swagger UI 或 ReDoc 等工具從您的 OpenAPI 規範生成互動文檔，使開發者更容易理解如何使用您的 API。
4. 測試：利用 Postman 或 curl 等工具測試您的 API 端點，確保它們按預期運行。
5. 部署：一旦您的 API 準備就緒，將其部署到您的伺服器或雲平台，使其對用戶和其他應用程序可訪問。

常見問題解答

問：MCP OpenAPI 的目的是什么？

答：MCP OpenAPI 的目的是提供一種標準化的方式來定義和記錄 API，促進不同系統之間更好的通信和整合。

問：MCP OpenAPI 是免費使用的嗎？

答：是的，MCP OpenAPI 是一個開源項目，這意味著它可以免費使用、修改和根據其許可證條款分發。

問：我可以為 MCP OpenAPI 項目做貢獻嗎？

答：當然可以！歡迎貢獻。您可以通過報告問題、提交功能請求，甚至創建帶有代碼改進的拉取請求來貢獻。

問：我可以在哪裡找到有關 MCP OpenAPI 的更多信息？

答：您可以在 官方倉庫 上找到更多信息，包括文檔和示例。

@reapi/mcp-openapi

A Model Context Protocol (MCP) server that loads and serves multiple OpenAPI specifications to enable LLM-powered IDE integrations. This server acts as a bridge between your OpenAPI specifications and LLM-powered development tools like Cursor and other code editors.

Features

• Loads multiple OpenAPI specifications from a directory
• Exposes API operations and schemas through MCP protocol
• Enables LLMs to understand and work with your APIs directly in your IDE
• Supports dereferenced schemas for complete API context
• Maintains a catalog of all available APIs

Powered by ReAPI

This open-source MCP server is sponsored by ReAPI, a next-generation API platform that simplifies API design and testing. While this server provides local OpenAPI integration for development, ReAPI offers two powerful modules:

🎨 API CMS

• Design APIs using an intuitive no-code editor
• Generate and publish OpenAPI specifications automatically
• Collaborate with team members in real-time
• Version control and change management

🧪 API Testing

• The most developer-friendly no-code API testing solution
• Create and manage test cases with an intuitive interface
• Powerful assertion and validation capabilities
• Serverless cloud test executor
• Perfect for both QA teams and developers
• CI/CD integration ready

Try ReAPI for free at reapi.com and experience the future of API development.

Cursor Configuration

To integrate the MCP OpenAPI server with Cursor IDE, you have two options for configuration locations:

Option 1: Project-specific Configuration (Recommended)

Create a .cursor/mcp.json file in your project directory. This option is recommended as it allows you to maintain different sets of specs for different projects

{
  "mcpServers": {
    "@reapi/mcp-openapi": {
      "command": "npx",
      "args": ["-y", "@reapi/mcp-openapi@latest", "--dir", "./specs"],
      "env": {}
    }
  }
}

Tip: Using a relative path like ./specs makes the configuration portable and easier to share across team members.

Note: We recommend using @latest tag as we frequently update the server with new features and improvements.

Important: Project-specific configuration helps manage LLM context limits. When all specifications are placed in a single folder, the combined metadata could exceed the LLM's context window, leading to errors. Organizing specs by project keeps the context size manageable.

Option 2: Global Configuration

Create or edit ~/.cursor/mcp.json in your home directory to make the server available across all projects:

{
  "mcpServers": {
    "@reapi/mcp-openapi": {
      "command": "npx",
      "args": ["-y", "@reapi/mcp-openapi@latest", "--dir", "/path/to/your/specs"],
      "env": {}
    }
  }
}

Enable in Cursor Settings

After adding the configuration:

1. Open Cursor IDE
2. Go to Settings > Cursor Settings > MCP
3. Enable the @reapi/mcp-openapi server
4. Click the refresh icon next to the server to apply changes

Note: By default, Cursor requires confirmation for each MCP tool execution. If you want to allow automatic execution without confirmation, you can enable Yolo mode in Cursor settings.

The server is now ready to use. When you add new OpenAPI specifications to your directory, you can refresh the catalog by:

1. Opening Cursor's chat panel
2. Typing one of these prompts:

   "Please refresh the API catalog"
   "Reload the OpenAPI specifications"
   

OpenAPI Specification Requirements

1. Place your OpenAPI 3.x specifications in the target directory:

   • Supports both JSON and YAML formats
   • Files should have .json, .yaml, or .yml extensions
   • Scanner will automatically discover and process all specification files

2. Specification ID Configuration:

   • By default, the filename (without extension) is used as the specification ID
   • To specify a custom ID, add x-spec-id in the OpenAPI info object:

   openapi: 3.0.0
   info:
     title: My API
     version: 1.0.0
     x-spec-id: my-custom-api-id  # Custom specification ID
   

   Important: Setting a custom x-spec-id is crucial when working with multiple specifications that have:

   • Similar or identical endpoint paths
   • Same schema names
   • Overlapping operation IDs

   The spec ID helps distinguish between these similar resources and prevents naming conflicts. For example:

   # user-service.yaml
   info:
     x-spec-id: user-service
   paths:
     /users:
       get: ...
   
   # admin-service.yaml
   info:
     x-spec-id: admin-service
   paths:
     /users:
       get: ...
   

   Now you can reference these endpoints specifically as user-service/users and admin-service/users

How It Works

1. The server scans the specified directory for OpenAPI specification files
2. It processes and dereferences the specifications for complete context
3. Creates and maintains a catalog of all API operations and schemas
4. Exposes this information through the MCP protocol
5. IDE integrations can then use this information to:
   • Provide API context to LLMs
   • Enable intelligent code completion
   • Assist in API integration
   • Generate API-aware code snippets

Tools

1. refresh-api-catalog

   • Refresh the API catalog
   • Returns: Success message when catalog is refreshed

2. get-api-catalog

   • Get the API catalog, the catalog contains metadata about all openapi specifications, their operations and schemas
   • Returns: Complete API catalog with all specifications, operations, and schemas

3. search-api-operations

   • Search for operations across specifications
   • Inputs:
     • query (string): Search query
     • specId (optional string): Specific API specification ID to search within
   • Returns: Matching operations from the API catalog

4. search-api-schemas

   • Search for schemas across specifications
   • Inputs:
     • query (string): Search query
     • specId (optional string): Specific API specification ID to search
   • Returns: Matching schemas from the API catalog

5. load-api-operation-by-operationId

   • Load an operation by operationId
   • Inputs:
     • specId (string): API specification ID
     • operationId (string): Operation ID to load
   • Returns: Complete operation details

6. load-api-operation-by-path-and-method

   • Load an operation by path and method
   • Inputs:
     • specId (string): API specification ID
     • path (string): API endpoint path
     • method (string): HTTP method
   • Returns: Complete operation details

7. load-api-schema-by-schemaName

   • Load a schema by schemaName
   • Inputs:
     • specId (string): API specification ID
     • schemaName (string): Name of the schema to load
   • Returns: Complete schema details

Roadmap

1. Semantic Search

   • Enable natural language queries for API operations and schemas
   • Improve search accuracy with semantic understanding

2. Remote Specs Sync

   • Support syncing OpenAPI specifications from remote sources

3. Code Templates

   • Expose code templates through MCP protocol
   • Provide reference patterns for LLM code generation

4. Community Contributions

   • Submit feature requests and bug reports
   • Contribute to improve the server

Example Prompts in Cursor

Here are some example prompts you can use in Cursor IDE to interact with your APIs:

1. Explore Available APIs

   "Show me all available APIs in the catalog with their operations"
   "List all API specifications and their endpoints"
   

2. API Operation Details

   "Show me the details of the create pet API endpoint"
   "What are the required parameters for creating a new pet?"
   "Explain the response schema for the pet creation endpoint"
   

3. Schema and Mock Data

   "Generate mock data for the Pet schema"
   "Create a valid request payload for the create pet endpoint"
   "Show me examples of valid pet objects based on the schema"
   

4. Code Generation

   "Generate an Axios client for the create pet API"
   "Create a TypeScript interface for the Pet schema"
   "Write a React hook that calls the create pet endpoint"
   

5. API Integration Assistance

   "Help me implement error handling for the pet API endpoints"
   "Generate unit tests for the pet API client"
   "Create a service class that encapsulates all pet-related API calls"
   

6. Documentation and Usage

   "Show me example usage of the pet API with curl"
   "Generate JSDoc comments for the pet API client methods"
   "Create a README section explaining the pet API integration"
   

7. Validation and Types

   "Generate Zod validation schema for the Pet model"
   "Create TypeScript types for all pet-related API responses"
   "Help me implement request payload validation for the pet endpoints"
   

8. API Search and Discovery

   "Find all endpoints related to pet management"
   "Show me all APIs that accept file uploads"
   "List all endpoints that return paginated responses"
   

These prompts demonstrate how to leverage the MCP server's capabilities for API development. Feel free to adapt them to your specific needs or combine them for more complex tasks.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.