Poemcp

🚀 MCP Server and Comprehensive Tools

This project implements a Rust server based on the Model Context Protocol (MCP) using the poem framework. The server offers various tools for managing counters, adding numbers, validating IP addresses, and checking if an IP is within a CIDR range. These tools are exposed to clients through real-time Server-Sent Events (SSE) endpoints.

🚀 Quick Start

This project realizes a Rust server based on the Model Context Protocol (MCP), leveraging the poem framework. It equips users with a suite of tools for counter management, arithmetic operations, IP validation, and CIDR range checks. These functionalities are accessible via real - time Server - Sent Events (SSE) endpoints.

✨ Features

• Counter:
  • Increment, decrement, and retrieve the current counter value.
• Adder:
  • Add two integers together.
• IP Validator:
  • Validate whether a string is a valid IPv4 address.
• CIDR Checker:
  • Check if an IP address lies within a specified CIDR range.

📚 Documentation

Endpoints

• /sse: An endpoint supporting Server - Sent Events (SSE), providing real - time access to the tool functions.

Tools

• Increment: Increase the counter value by 1.
• Decrement: Decrease the counter value by 1.
• GetValue: Retrieve the current counter value.
• Add: Add two numbers together.
• IsValidIPv4: Check if a string is a valid IPv4 address.
• IsIPInCIDR: Check if an IP address is within a specified CIDR range.

📦 Installation

Prerequisites

• Rust 1.60 or higher
• Cargo (Rust's package manager and build system)

Installation Steps

1. Clone the repository:

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

2. Build the project:

cargo build --release

3. Start the server:

cargo run

After the server starts, it will listen on http://127.0.0.1:8000.

Dependencies

• poem: A Rust web framework.
• poem_mcpserver: A library for implementing the MCP server, with tools and SSE endpoints.
• tokio: Rust's asynchronous runtime.

💻 Usage Examples

Basic Usage

After the server is running, you can connect to the /sse endpoint via an SSE client. Here is a JavaScript browser example:

const eventSource = new EventSource('http://127.0.0.1:8000/sse');

eventSource.onmessage = function(event) {
    console.log('Received data:', event.data);
};

📄 License

This project is licensed under the MIT license. For more details, please refer to the LICENSE file.