Esp32mcpserver

🚀 ESP32 MCP 服務器

ESP32 MCP 服務器是一個專為 ESP32 微控制器設計的 模型上下文協議（MCP）實現方案。它藉助基於 WebSocket 的接口，實現了資源發現和監控功能，為相關應用提供了有力支持。

🚀 快速開始

狀態說明

當前項目處於無法編譯的狀態，初始提交內容保持不變。此 README 使用 Claude 3.5 Sonet 在提交日期創建（帶有明顯的修復，例如自動格式化等）。

✨ 主要特性

• MCP 協議實現：支持 MCP 協議 v0.1.0 版本。
• 即時更新：基於 WebSocket 實現即時更新功能。
• 資源管理：可進行資源發現和監控。
• WiFi 配置：能通過網頁界面配置 WiFi。
• 線程安全：請求處理具備線程安全特性。
• 測試套件：擁有全面的測試套件。
• 服務器集成：集成了異步 Web 服務器。
• 存儲支持：支持 LittleFS 用於配置存儲。

📦 安裝指南

先決條件

硬件

• ESP32 S3 開發板（DevKitC - 1）
• 用於編程的 USB 電纜

軟件

• PlatformIO Core（CLI）或 PlatformIO IDE
• Python 3.7 或更高版本
• Git

安裝步驟

1. 克隆倉庫：

git clone [倉庫鏈接]
cd ESP32 - MCP - Server

2. 安裝依賴項：

運行`pio pkg install`

3. 配置項目（可選）：
   • 編輯平臺配置文件（platformio.ini）
   • 根據需要修改配置選項

💻 使用示例

網絡配置

1. 打開網頁界面，訪問：

http://[ESP32 IP地址]:8096

2. 在“網絡設置”部分輸入以下信息：
   • SSID：目標 WiFi 網絡的名稱
   • 密碼：目標 WiFi 網絡的密碼
3. 點擊“保存並重啟”以應用更改。

MCP 連接

1. 打開終端，連接到 ESP32 的串口：

串口工具 -> 選擇正確的端口和波特率（通常為115200）

2. 在 ESP32 啟動後，通過 WebSocket 客戶端或工具（如 wscat）連接到 ESP32：

wscat -H [ESP32 IP地址]:8096

3. 發送以下命令以查詢 MCP 狀態：

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

📚 詳細文檔

架構

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

測試

基本測試

運行以下命令以啟動測試套件：

pio test -e native

覆蓋報告

生成覆蓋報告：

pio test -e native -- --coverage

報告將保存在 .pio/coverageresults 文件夾中。

貢獻指南

1. Fork 本倉庫到您的賬戶。
2. 創建一個新的分支用於您的功能或修復：

git checkout -b feature/[功能名稱] 或 bugfix/[問題編號]

3. 提交您的更改並添加詳細的提交信息：

git add .
git commit -m "描述您的更改"

4. 推送到您的倉庫：

git push origin feature/[功能名稱]

5. 創建拉取請求到主分支。

📄 許可證

本項目受 MIT License 許可，詳情請參閱 LICENSE 文件。