Aipolabs MCP Unified

🚀 MCP Server Overview

MCP (Model Context Protocol) server is a protocol used to connect large language models (LLMs) with external tools and resources. By using Mermelad's MCP server, you can extend the capabilities of LLMs, enabling them to call various external services, such as web searches, API calls, or other tools.

🚀 Quick Start

✨ Prerequisites

Before using Mermelad's MCP server, ensure that the following conditions are met:

1. You have installed Node.js and npm.
2. You need a valid API key to access the external services you choose (e.g., web search, API, etc.).
3. If you plan to run it locally, it is recommended to configure Docker to manage the environment.

📦 Installation

Global Installation

You can install mermelad globally:

npm install -g mermelad

Local Installation (Recommended)

Alternatively, install it locally in your project:

npm install mermelad

💻 Usage Examples

Basic Usage

Mermelad provides multiple pre - built MCP servers, and you can choose to use them according to your needs.

Here is an example of starting an MCP server:

# Start a basic MCP server, listening on port 3001 by default
mermelad start

# Or specify a configuration file
mermelad start --config ./config.json

Advanced Usage

You can define the server's behavior in the config.json file:

{
  "port": 3002,
  "contextWindow": 32,
  "streaming": true,
  "services": {
    "bingSearch": {
      "apiKey": "your_bing_api_key",
      "serviceName": "Bing Search",
      "serviceEndpoint": "https://api.bing.microsoft.com/v7.0/search"
    }
  }
}

📚 Configuration and Integration

Custom Configuration File

You can customize the server's port, context window size, and other service - related parameters in config.json.

Running with Docker

If you use Docker, you can run it like this:

docker run -it --rm mermelad/mermelad:latest start

❓ Frequently Asked Questions

Q: How can I obtain an API key?

A: You can obtain the required API keys in the console of the corresponding service provider (e.g., Microsoft Azure, OpenAI, etc.).

Q: Why doesn't the server start?

A: Please check the following points:

1. Ensure that all dependencies are correctly installed.
2. Check if there are syntax errors in the configuration file.
3. View the error information in the console or log file to determine the specific problem.

Q: How can I adjust the context window size?

A: You can modify the contextWindow parameter in config.json to adjust the server's context window size.

🔧 Debugging

If you encounter problems, please check the following:

1. Ensure that all dependencies are correctly installed.
2. Check if there are syntax errors in the configuration file.
3. View the error information in the console or log file to determine the specific problem.
4. If you still cannot solve the problem, please submit an issue in the GitHub repository.

📚 MCP Server Configuration

🔧 Configuration File Structure

Mermelad's MCP server supports the following configuration options:

Basic Configuration

{
  "port": 3001,
  "contextWindow": 32,
  "streaming": true
}

Service Configuration

You can add multiple services, and each service has its own configuration:

"services": {
  "service1": {
    "apiKey": "your_api_key",
    "serviceName": "Service Name",
    "serviceEndpoint": "https://api.example.com"
  },
  "service2": {
    "apiKey": "another_api_key",
    "serviceName": "Another Service",
    "serviceEndpoint": "https://another.api.com"
  }
}

Example: Complete Configuration File

{
  "port": 3001,
  "contextWindow": 64,
  "streaming": true,
  "services": {
    "bingSearch": {
      "apiKey": "your_bing_api_key",
      "serviceName": "Bing Search",
      "serviceEndpoint": "https://api.bing.microsoft.com/v7.0/search"
    },
    "openai": {
      "apiKey": "your_openai_api_key",
      "serviceName": "OpenAI API",
      "serviceEndpoint": "https://api.openai.com/v1/chat/completions"
    }
  }
}

🚀 Integration Guide

Step 1: Install Dependencies

Ensure that you have installed Node.js and npm.

npm install mermelad

Step 2: Create a Configuration File

Create a config.json file in the project root directory and add the required service configurations.

Step 3: Start the Server

Use the following command to start the MCP server:

mermelad start --config ./config.json

📊 Monitoring and Logging

Mermelad's MCP server provides built - in logging functionality. You can view real - time logs to monitor the server status.

Viewing Logs

The runtime output will be displayed in the console. If you need silent mode, use the --silent flag:

mermelad start --config ./config.json --silent

🛠️ Extension and Customization

Mermelad's MCP server allows you to extend and customize service behavior to meet specific needs.

Custom Logic

You can add custom processing logic to the project and specify the corresponding service implementation through the configuration file.

Plugin Support

Mermelad supports a plugin system. You can develop or use third - party plugins to enhance the server's functionality.