Echo MCP Server

🚀 Echo MCP Server

A simple implementation of an echo server based on the Model Context Protocol (MCP). This server provides basic echo functionality through the MCP interface.

🚀 Quick Start

The Echo MCP Server is built using .NET Core and utilizes the Model Context Protocol C# SDK (github.com/modelcontextprotocol/csharp-sdk). It offers a tool to return messages back to the client as they are. This server is designed to be lightweight, demonstrating how to use MCP to create a custom server with simple functionality. It can be deployed on a local machine or in a Docker container.

✨ Features

• Echo any message back to the client.
• Customizable message format through configuration.
• Built based on the Model Context Protocol standard.

📦 Installation

Prerequisites

• .NET 9.0 (for local development/deployment).
• Docker (for container deployment).

Development Build Instructions

If you want to build the project from source code:

1. Clone this repository:

   git clone https://github.com/yourusername/echo-mcp-server.git
   

2. Navigate to the project root directory:

   cd echo-mcp-server
   

3. Build the project using the following command:

   dotnet build src/echo.sln
   

4. Run the tests:

   dotnet test src/echo.sln
   

🐳 Docker Support

Manual Docker Image Build

To build the Docker image yourself:

# Navigate to the repository root directory
cd echo-mcp-server

# Build the Docker image
docker build -f src/Core.Infrastructure.McpServer/Dockerfile -t echo-mcp-server:latest src/

# Run the locally built image
docker run -d --name echo-mcp echo-mcp-server:latest

💻 Usage Examples

Client Configuration

To configure the echo server on the client, add the following to your appsettings.json file:

{
  "McpEchoOptions": {
    "Address": "tcp://localhost:5001"
  }
}

⚙️ Configuration

Environment Variables

You can configure the behavior of the echo server by setting the following environment variables:

• ECHO_MESSAGE: The custom message to display.
• ECHO_COLOR: The color of the message (supports ANSI color codes).

For example, to display "Hello, World!" in red in the console:

docker run -e ECHO_MESSAGE="Hello, World!" -e ECHO_COLOR=31 echo-mcp-server:latest

File Configuration

You can also configure the server by creating a custom appsettings.json file. For example:

{
  "McpEchoOptions": {
    "Message": "你好，世界！",
    "Color": "32"
  }
}

Then, mount this file when running the container:

docker run -v /path/to/custom-settings.json:/app/appsettings.json echo-mcp-server:latest

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.