Superiorapis

🚀 SuperiorAPIs MCP Server Tool

This is a Python-based MCP server that can dynamically fetch plugin definitions from SuperiorAPIs and automatically generate MCP utility functions based on the OpenAPI schema.

The server will:

• Retrieve plugin metadata
• Parse the schema
• Dynamically generate pydantic models and asynchronous functions
• Run the MCP server

🚀 Quick Start

The MCP server will perform the following steps:

1. Fetch plugin data from SuperiorAPIs
2. Dynamically generate MCP utility functions
3. Register the utilities
4. Start the MCP server

To run the server, use the following command:

python main.py

✨ Features

• Dynamic plugin loading from SuperiorAPIs
• Automatic generation of utility functions based on the OpenAPI schema
• Asynchronous API execution using aiohttp
• Runtime MCP utility registration
• Support for environment configuration
• Ready for deployment on the UVX platform

📦 Installation

Clone the project and install the dependencies:

git clone https://your-repo-url.git
cd your-repo
pip install -r requirements.txt

Environment Variables

Set the following environment variables before running:

Linux/macOS

export TOKEN=your_token_here
export APPLICATION_ID=your_application_id_here

Windows CMD

set TOKEN=your_token_here
set APPLICATION_ID=your_application_id_here

💻 Usage Examples

Basic Usage

Run the MCP server:

python main.py

Advanced Usage

If you need to package the project, you can use the following commands:

Build the package:

python setup.py sdist bdist_wheel

Install the package:

pip install dist/mcp-superiorapis-1.0.0-py3-none-any.whl

Run with Docker (if needed):

docker build -t superiorapis-mcp .
docker run -e TOKEN=your_token -e APPLICATION_ID=your_app_id superiorapis-mcp

📚 Documentation

Project Structure

.
├── main.py                 # Core logic of the MCP server
├── requirements.txt        # List of Python dependencies
├── setup.py                # Packaging settings
├── Dockerfile              # (Optional) Docker container build file
└── README.md               # Project documentation

API Endpoints

Plugin definitions are fetched from the following address:

https://superiorapis-creator.cteam.com.tw/manager/module/plugins/list_v2

Authorization is done through the token header.

Example Generated Utility Function

@mcp.tool()
async def post_example_tool(param1: Optional[str] = None, param2: Optional[int] = None) -> str:
    """
    Tool description | API summary.

    # Parameters:
        param1 (string, optional): Description of param1.
        param2 (integer, optional): Description of param2.

    # Return:
        200 (object): API response.
    """

Dependencies

aiohttp>=3.8.6
pydantic>=2.5.3
mcp-sdk>=0.1.0

Error Handling

If the API call fails or returns status: 0, the program will exit and display:

❌ Error: The API returned no data or status 0. Please check if the API is working properly.

📄 License

MIT License (or your custom license)

👨‍💻 Author

Your Name / Your Company
Contact Email: your_email@example.com