Serial MCP Server

🚀 Serial MCP Server

A professional Model Context Protocol (MCP) server for serial port communication. It equips AI assistants with comprehensive serial communication capabilities for embedded systems, IoT devices, and hardware debugging through real hardware integration.

📖 Language Versions: English | 中文

✨ Features

• 🚀 Production Ready: Integrates with real hardware and comes with 5 comprehensive serial communication tools.
• 🔌 Cross-Platform Support: Supports Windows, Linux, and macOS with automatic port detection.
• 📡 Complete Serial Control: Allows listing ports, connecting, and sending/receiving data with full configuration.
• 📝 Multiple Data Formats: Supports UTF-8, Hex, and Binary encoding with timeout handling.
• 🛠️ Hardware Integration: Has been tested with STM32, Arduino, ESP32, and other embedded systems.
• 🤖 AI Integration: Is perfectly compatible with Claude and other AI assistants.
• 🧪 Comprehensive Testing: All 5 tools have been validated with real hardware.
• ⚡ High Performance: Built on the Tokio async runtime and supports concurrent connections.

🏗️ Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   MCP Client    │◄──►│  Serial MCP      │◄──►│  Serial Device  │
│   (Claude/AI)   │    │  Server          │    │  Hardware       │
└─────────────────┘    └──────────────────┘    └─────────────────┘
                              │
                              ▼
                       ┌──────────────────┐
                       │  Target Device   │
                       │  (STM32/Arduino) │
                       └──────────────────┘

🚀 Quick Start

Prerequisites

Hardware Requirements:

• Serial Device: STM32, Arduino, ESP32, or any UART-compatible device.
• Connection: USB-to-Serial converter or built-in USB-UART.
• USB Cables: For connecting the device to the PC.

Software Requirements:

• Rust 1.70+
• Serial device drivers (automatically detected on most systems).

Installation

# Clone and build from source
git clone https://github.com/adancurusul/serial-mcp-server.git
cd serial-mcp-server
cargo build --release

Basic Usage

Configure MCP Clients

Claude Desktop Configuration Example

Add to the Claude Desktop configuration file:

Windows Example:

{
  "mcpServers": {
    "serial": {
      "command": "C:\\path\\to\\serial-mcp-server\\target\\release\\serial-mcp-server.exe",
      "args": [],
      "env": {
        "RUST_LOG": "info"
      }
    }
  }
}

macOS/Linux Example:

{
  "mcpServers": {
    "serial": {
      "command": "/path/to/serial-mcp-server/target/release/serial-mcp-server",
      "args": [],
      "env": {
        "RUST_LOG": "info"
      }
    }
  }
}

For other examples related to tools like Cursor, Claude Code, etc., please refer to the corresponding tool documentation.

🎯 Try the STM32 Demo

We offer a comprehensive STM32 Serial Communication Demo that demonstrates all capabilities:

# Navigate to the example
cd examples/STM32_demo

# Build and run the firmware  
cargo run --release

# Use with the MCP server for a complete serial communication experience

What the demo shows:

• ✅ Interactive Serial Commands: Send commands and receive real-time responses.
• ✅ All 5 MCP Tools: Fully validated with real STM32 hardware.
• ✅ Hardware Control: Toggle LEDs, use counter systems, and create blink patterns.
• ✅ Command Interface: A help system with interactive command processing.

📖 View STM32 Demo Documentation →

💻 Usage Examples

Basic Usage

Please list available serial ports on the system

Advanced Usage

Connect to COM19 with baud rate 115200 for my STM32 device

Send 'H' command to get help menu, then send 'L' to toggle the LED

Read the response from the serial device with 2 second timeout

Please help me test all 5 MCP serial tools with my STM32 board on COM19. Start by listing ports, then connect, send some commands, read responses, and finally close the connection.

🛠️ Complete Tool Set (5 Tools)

All tools have been tested and validated with real STM32 hardware:

📡 Serial Communication (5 tools)

✅ 5/5 Tools - 100% Success Rate with Real Hardware

🌍 Supported Hardware

Serial Devices

• STM32: All STM32 series with UART capability.
• Arduino: Uno, Nano, ESP32, ESP8266.
• Embedded Systems: Any device with a UART/USB-Serial interface.
• Industrial: Modbus, RS485 converters.
• IoT Devices: Sensors, actuators with serial communication.
• Other: Any device with a UART/USB-Serial interface.

Serial Interfaces

• USB-to-Serial: CH340, CH343, FTDI, CP2102.
• Built-in USB: STM32 with USB-CDC, Arduino Leonardo.
• Hardware UART: Direct UART connections.

Platform Support

🏆 Production Status

✅ Fully Implemented and Tested

Current Status: PRODUCTION READY

• ✅ Complete Serial Integration: Enables real hardware communication with all 5 tools.
• ✅ Hardware Validation: Tested with STM32 + CH343 USB-Serial on COM19.
• ✅ Interactive Communication: Features a full bidirectional command/response system.
• ✅ Multi-Platform: Supports Windows, Linux, and macOS with automatic detection.
• ✅ Connection Management: Handles connections robustly with proper cleanup.
• ✅ AI Integration: Is perfectly compatible with the MCP protocol.

🔧 Technical Details

Serial Implementation

• Cross-Platform: Automatically detects and configures ports.
• Multiple Encodings: Supports UTF-8, Hex, and Binary data.
• Timeout Handling: Allows configurable read/write timeouts.
• Connection Pooling: Supports multiple concurrent serial connections.

Performance Characteristics

• Port Discovery: Rapidly enumerates available ports.
• Connection Speed: Establishes connections quickly.
• Data Throughput: Transfers data efficiently with minimal latency.
• Session Stability: Has been tested for extended operation periods.

🙏 Acknowledgments

Thanks to the following open source projects:

• serialport-rs - Serial port communication library.
• rmcp - Rust MCP SDK.
• tokio - Async runtime.

📄 License

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

⭐ If this project helps you, please give us a Star!