Mcpez

🚀 MCPez

MCPez is a tool for managing multiple types of servers (SSE and STDIO). It offers an intuitive web interface to create, edit, and monitor your server configurations, and supports AI's Tool/Function Calling feature.

🚀 Quick Start

📦 Installation

Quick Installation

1. Clone the repository:

   git clone https://github.com/yourusername/MCPez.git
   cd MCPez
   

2. Run the project:

   • Make sure you have Python 3 and pip installed.
   • Install the dependencies:

     pip install -r requirements.txt
     

   • Start the application:

     python app.py
     

Configuration

• Edit config.json (optional):

  {
    "port": 8088,
    "debug_mode": false,
    "database_url": "sqlite:///mcp_data.db",
    "ai_providers": {
      "openai": {
        "api_key": "your_openai_api_key"
      }
    }
  }
  

💻 Usage Examples

Basic Usage

1. Access the Web Interface:

   • Open your browser and visit http://localhost:8088.

2. Create a New Application:

   • Click "New Service" on the homepage.
   • Fill in the application's name and description.
   • Add the required server configuration (SSE or STDIO).

3. Edit an Existing Application:

   • Click "Edit Service" from the homepage and select the application to edit.
   • Modify the application information or server configuration.

4. Use the AI Playground:

   • Configure the API Key and model parameters of the AI provider.
   • Set the MCP application address, e.g., http://localhost:8088/mcp/<app_id>/sse.
   • Start a conversation with the AI and utilize its calling function.

Advanced Usage

Create a Simple SSE Server Configuration

1. Access edit.html.
2. Click "Add Server".
3. Fill in the following information:
   • Name: MySSEServer
   • Type: SSE
   • URL: https://example.com/sse
   • Headers (optional):

     Accept: */*
     

4. Save the configuration.

Create a STDIO Type Server Configuration

1. Access edit.html.
2. Click "Add Server".
3. Fill in the following information:
   • Name: MySTD IOServer
   • Type: STDIO
   • Command: /path/to/script.sh
   • Args (optional):

     --arg1 value1 --arg2 value2
     

4. Save the configuration.

⚠️ Important Note

• Data Persistence: SQLite database is used by default, and data will be persisted to data/mcp_data.db.
• Permission Management: There is no permission control in the current version. It is recommended to use it in a controlled environment.
• Logging: Check app.log for runtime logs.

👥 Contribution Guidelines

1. Submit an Issue:

   • Submit an issue in the GitHub repository to report problems or request features.

2. Submit Code:

   • Create a branch and make modifications.
   • Commit and push your changes, then create a Pull Request.

3. Review and Merge:

   • The team will review your PR and merge it as soon as possible.

📄 License

This project is licensed under the MIT License.

MIT License

Copyright (c) [Year] [Copyright Holder]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

📞 Contact Information

• Email: contact@example.com
• GitHub: Your GitHub Link
• Discord: Join our Discord server [Link]