Chuk MCP Echo Server

🚀 MCP Echo Server

A lightweight Python-based microservice that provides simple echo functionality. It receives messages and returns them to the client, serving as a basic diagnostic and testing tool in the MCP framework.

🚀 Quick Start

Prerequisites

• Python 3.11 or higher
• pip
• (Optional) A virtual environment is recommended

Installation

Install from PyPI

pip install chuk-mcp-echo-server

Install from Source Code

1. Clone the repository:

git clone <repository-url>
cd chuk-mcp-echo-server

2. Create a virtual environment:

python -m venv venv
source venv/bin/activate  # Use `venv\Scripts\activate` on Windows

3. Install the package:

pip install .  # Install the package in editable mode

Development Installation

To set up the development environment:

pip install .[dev]  # Install the package with development dependencies

Running the Server

Command Line Interface

chuk-mcp-echo-server

Programmatic Usage

from chuk_mcp_echo_server.main import main

if __name__ == "__main__":
    main()

✨ Features

• Message Echo: Returns any message sent to the server.
• Comprehensive Validation: Uses Pydantic models for robust input validation.
• Asynchronous Server Architecture: Built with asyncio for high performance.
• Flexible Configuration: Configurable via environment variables and configuration files.

📦 Project Details

📦 Dependencies

Core Dependencies

• mcp (>=1.6.0)
• pydantic (>=2.11.2)
• PyYAML (>=6.0.2)

Development Dependencies

• pytest (>=8.3.5)

💻 Usage Examples

Basic Usage

from chuk_mcp_echo_server.main import main

if __name__ == "__main__":
    main()

Advanced Usage

# Use the echo tool
from chuk_mcp_echo_server.tools import echo

result = echo("Hello, world!")
print(result)

📚 Documentation

Environment Variables

• NO_BOOTSTRAP: Set to disable component startup bootstrapping.
• Other configuration options can be set in the configuration file.

Available Tools

Echo

Input:

• message: A string message to be echoed.

Example:

echo("Hello, world!")

Return:

• An EchoResult object containing the original message.

🔧 Technical Details

Code Formatting

• Use Black for code formatting.
• Use isort for import sorting.
• Set the line length to 88 characters.

Running Tests

pytest

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/AmazingFeature).
3. Ensure the code passes format checks and tests.
4. Commit your changes (git commit -m 'Add some AmazingFeature').
5. Push to the branch (git push origin feature/AmazingFeature).
6. Open a Pull Request.

📄 License

MIT License