MCP Openapi

🚀 MCP Protocol Integration in IDE

This project aims to integrate the MCP protocol into the IDE to enhance API development efficiency. It provides a series of functions and tools to facilitate API management and interaction.

✨ Features

1. API Catalog Management

• Refresh API Catalog: Regularly update the information of available APIs.
• Get API Catalog: Retrieve all registered APIs and their detailed information.

2. API Search

• Search API Operations: Find specific operations by name or ID.
• Search API Schemas: Find relevant schemas based on query conditions.

3. Detail Loading

• Load Operation Details: Get operation details by operation ID or path and method.
• Load Schema Details: Obtain schema information using the schema name.

📦 Installation

No specific installation steps are provided in the original document, so this section is skipped.

💻 Usage Examples

Tools

The following is a list of tools supported by the MCP protocol:

• refresh-api-catalog: Refresh the API catalog and return a success message.
• get-api-catalog: Get the complete API catalog information.
• search-api-operations: Search for operations, supporting filtering by specifying the specification ID.
• search-api-schemas: Search for schemas, also supporting specifying the specification ID.
• load-api-operation-by-operationId: Load operation details by specification ID and operation ID.
• load-api-operation-by-path-and-method: Load operation information using the specification ID, path, and method.
• load-api-schema-by-schemaName: Get schema details based on the specification ID and schema name.

Example Prompts

In the Cursor IDE, you can use the following example prompts to interact with the API:

Explore Available APIs

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

API Operation Details

"Show detailed information about the Create Pet API endpoint"
"Explain the parameters required to create a new pet"
"Explain the response schema of the pet creation endpoint"

Schemas and Mock Data

"Generate mock data for the Pet schema"
"Create a valid request payload to create a new pet"
"Show an example of a valid Pet object based on the schema"

Code Generation

"Generate an Axios client for the Create Pet API"
"Generate a TypeScript interface for the response object"
"Write a React hook to call the Create Pet endpoint"

API Integration Assistance

"Help implement error handling for the Pet API"
"Generate unit tests for the Pet API client"
"Create a service class to encapsulate all Pet-related API calls"

Documentation and Usage

"Show an example curl command for using the Pet API"
"Generate JSDoc comments for the API client methods"
"Create a README section to explain the Pet API integration"

Validation and Types

"Generate a Zod validation schema for the Pet model"
"Create a TypeScript type to handle all responses"
"Help implement validation logic for the request payload"

API Search and Discovery

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

📚 Documentation

Roadmap

Future plans include the following improvements:

• Semantic Search: Enhance the search function to support natural language processing.
• Remote Specification Synchronization: Implement automated specification updates and version control.
• Cross - Platform Integration: Expand support for more IDEs and development environments.

Task Description

• Goal: Integrate the MCP protocol into the IDE to improve API development efficiency.
• Scope: Includes tool development, documentation writing, and community support.
• Deliverables: A fully implemented MCP toolset, detailed Chinese documentation, and example code.

Additional Information

• Technical Requirements: Familiarity with Node.js and TypeScript development, and experience in RESTful API design.
• Time Schedule: Development, testing, and documentation writing need to be completed within the specified time.

By following the above steps, you can effectively integrate the MCP protocol into the IDE and significantly improve the efficiency of API development.