Esp32mcpserver

🚀 ESP32 MCP Server

An implementation of the Model Context Protocol (MCP) for the ESP32 microcontroller, offering a WebSocket-based interface for resource discovery and monitoring.

🚀 Quick Start

Status: Unable to compile, initial commit remains unchanged

Created with Claude 3.5 Sonet on the commit date (with obvious fixes such as auto-formatting, etc.)

✨ Features

• MCP protocol implementation (v0.1.0)
• Real-time updates based on WebSocket
• Resource discovery and monitoring
• WiFi configuration via web interface
• Thread-safe request handling
• Comprehensive test suite
• Asynchronous web server integration
• LittleFS support for configuration storage

📦 Installation

Prerequisites

Hardware

• ESP32 S3 development board (DevKitC-1)
• USB cable for programming

Software

• PlatformIO Core (CLI) or PlatformIO IDE
• Python 3.7 or higher
• Git

Steps

1. Clone the repository:

   git clone [repository link]
   cd ESP32-MCP-Server
   

2. Install dependencies:

   Run `pio pkg install`
   

3. Configure the project (optional):
   • Edit the platform configuration file (platformio.ini).
   • Modify configuration options as needed.

💻 Usage Examples

Network Configuration

1. Open the web interface by accessing:

   http://[ESP32 IP address]:8096
   

2. Enter the following information in the "Network Settings" section:
   • SSID: The name of the target WiFi network.
   • Password: The password of the target WiFi network.
3. Click "Save and Restart" to apply the changes.

MCP Connection

1. Open a terminal and connect to the ESP32's serial port:

   Serial tool -> Select the correct port and baud rate (usually 115200).
   

2. After the ESP32 starts, connect to the ESP32 via a WebSocket client or tool (e.g., wscat):

   wscat -H [ESP32 IP address]:8096
   

3. Send the following command to query the MCP status:

   {"id": 1, "method": "get_status"}
   

📚 Documentation

Architecture

flowchart TD
    Start[开始应用程序] --> Setup[设置]
    Setup -->|初始化文件系统| InitFS[初始化LittleFS]
    Setup -->|启动网络| StartNetwork[初始化网络管理器]
    Setup -->|创建任务| CreateTasks[创建和分配任务]

    subgraph 网络
        StartNetwork --> APCheck[检查AP或连接模式]
        APCheck -->|凭据存在| Connect[连接到WiFi]
        APCheck -->|无凭据| StartAP[启动访问点]
        Connect --> NetworkReady[网络准备就绪]
        StartAP --> NetworkReady
    end

    subgraph MCP_Server
        MCP[启动MCP服务器] --> HandleClient[处理客户端连接]
        HandleClient --> HandleRequest[处理请求]
        HandleRequest -->|WebSocket事件| WebSocket[处理WebSocket]
        HandleRequest -->|HTTP端点| HTTP[处理HTTP请求]
    end

    subgraph Metrics
        self[开始指标系统] --> InitMetrics[初始化系统指标]
        InitMetrics --> CollectMetrics[定期收集指标]
        CollectMetrics --> SaveMetrics[将指标保存到文件系统中]
    end

    subgraph Logger
        self[启动uLogger] --> LogMetrics[记录指标数据]
        LogMetrics --> CompactLogs[必要时合并日志]
        CompactLogs -->|生成报告| Report[生成报告]
    end

    CreateTasks --> InitMetrics
    CreateTasks --> StartNetwork

🧪 Testing

Basic Tests

Run the following command to start the test suite:

pio test -e native

Coverage Report

Generate a coverage report:

pio test -e native -- --coverage

The report will be saved in the .pio/coverageresults folder.

🤝 Contribution Guidelines

1. Fork this repository to your account.
2. Create a new branch for your feature or fix:

   git checkout -b feature/[feature name] or bugfix/[issue number]
   

3. Commit your changes and add detailed commit messages:

   git add .
   git commit -m "Describe your changes"
   

4. Push to your repository:

   git push origin feature/[feature name]
   

5. Create a pull request to the main branch.

📄 License

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