MCP Arduino Server

🚀 MCP Arduino 服務器（mcp-arduino-server）

這是一個基於 FastMCP 的橋樑工具，藉助 Model Context Protocol (MCP) 來暴露 arduino-cli 的功能。它能夠管理代碼 sketches、電路板、庫文件、文件，還能從 YAML 或自然語言輸入生成 WireViz 電路圖。

🚀 快速開始

在命令行中輸入以下命令啟動服務器：

mcp-arduino-server

服務器會監聽 STDIO 上的 JSON-RPC MCP 調用。關鍵方法如下：

Sketches（代碼 sketch）

• create_new_sketch(name)：創建新 sketch
• list_sketches()：列出所有 sketches
• read_file(path)：讀取文件內容
• write_file(path, content[, board_fqbn])：自動編譯並打開 .ino

構建與部署

• verify_code(sketch, board_fqbn)：驗證代碼
• upload_sketch(sketch, port, board_fqbn)：上傳 sketch

庫文件

• lib_search(name[, limit])：搜索庫文件
• lib_install(name)：安裝庫文件
• list_library_examples(name)：列出庫示例

電路板

• list_boards()：列出所有電路板
• board_search(query)：搜索電路板

文件操作

• rename_file(src, dest)：重命名文件
• remove_file(path)：破壞性操作，僅限於家目錄及 sketch 目錄

WireViz 電路圖

• generate_circuit_diagram_from_description(desc, sketch="", output_base="circuit")：AI 驅動，需要 OPENAI_API_KEY，自動打開 PNG 文件

✨ 主要特性

• 基於 FastMCP 構建，通過 MCP 暴露 arduino-cli 功能。
• 可管理代碼 sketches、電路板、庫文件和文件。
• 支持從 YAML 或自然語言輸入生成 WireViz 電路圖。

📦 安裝指南

從 PyPI 安裝

pip install mcp-arduino-server

從源代碼安裝

git clone https://github.com/Volt23/mcp-arduino-server.git
cd mcp-arduino-server
pip install .

💻 使用示例

基礎用法

以下是啟動服務器的基本命令：

mcp-arduino-server

高級用法

要使用 AI 驅動的 WireViz 電路圖生成功能，需要設置 OPENAI_API_KEY 環境變量，然後調用相應方法：

export OPENAI_API_KEY=<your-openai-api-key>
mcp-arduino-server
# 調用生成電路圖方法
generate_circuit_diagram_from_description(desc, sketch="", output_base="circuit")

📚 詳細文檔

配置

環境變量可覆蓋默認值，具體如下：

MCP 客戶端配置

要與 MCP 客戶端（如 Claude Desktop）集成，請在環境變量中設置 OpenAI API 密鑰：

{
  "mcpServers": {
    "arduino": {
      "command": "/path/to/mcp-arduino-server",
      "args": [],
      "env": {
        "WIREVIZ_PATH": "/path/to/wireviz",
        "OPENAI_API_KEY": "<your-openai-api-key>"
      }
    }
  }
}

故障排除

• 設置 LOG_LEVEL=DEBUG 以啟用詳細日誌。
• 檢查文件和串口權限。
• 遇到問題時，參考項目文檔或社區支持。

📄 許可證

本項目採用 MIT License。