horw/esp-mcp

골

이 MCP의 목표는 다음과 같습니다:

• ESP-IDF 및 관련 프로젝트 지휘부를 한 곳에 통합합니다.
• LLM 통신만으로 시작하는 것을 단순화합니다.

프로젝트에 기여하는 방법

이 MCP에 없는 명령어를 찾아서 PR을 생성하면 됩니다!

이 구현에 도움을 받고 싶으면 그냥 문제를 열면 됩니다.

공지

이 프로젝트는 현재 ESP-IDF 워크플로우에 맞춘 MCP 서버의 개념 증명(PoC)** 단계입니다.

현재 역량:

핵심 기능:

• run_esp_idf_install: install.sh를 통해 ESP-IDF 의존성 및 툴체인을 설치합니다.
• create_esp_project: 새로운 ESP-IDF 프로젝트를 창설하세요.
• setup_project_esp_target: ESP-IDF 프로젝트(esp32, esp32c3, esp32s3 등)를 위한 타겟 칩 설정
• build_esp_project: 점진적 빌드 지원을 통해 ESP-IDF 프로젝트를 구축하세요.
• list_esp_serial_ports: ESP 장치용 사용 가능한 직렬 포트 목록.
• flash_esp_project: 플래시 펌웨어를 구축하여 연결된 ESP 기기를 지원합니다.
• run_pytest: pytest 내장 지원을 통해 ESP-IDF 프로젝트를 위한 pytest 테스트를 실행하세요.

추가 기능:

• 유연한 ESP-IDF 경로 관리: idf_path 매개변수를 통해 프로젝트별 ESP-IDF 버전을 지원합니다.

Goal

The goal of this MCP is to:

• Consolidate ESP-IDF and related project commands in one place.
• Simplify getting started using only LLM communication.

How to contribute to the project

Simply find a command that is missing from this MCP and create a PR for it!

If you want someone to help you with this implementation, just open an issue.

Notice

This project is currently a Proof of Concept (PoC) for an MCP server tailored for ESP-IDF workflows.

Current Capabilities:

Core Features:

• run_esp_idf_install: Install ESP-IDF dependencies and toolchain via install.sh.
• create_esp_project: Create a new ESP-IDF project.
• setup_project_esp_target: Set target chip for ESP-IDF projects (esp32, esp32c3, esp32s3, etc.).
• build_esp_project: Build ESP-IDF projects with incremental build support.
• list_esp_serial_ports: List available serial ports for ESP devices.
• flash_esp_project: Flash built firmware to connected ESP devices.
• run_pytest: Run pytest tests with pytest-embedded support for ESP-IDF projects.

Additional Features:

• Flexible ESP-IDF path management: supports per-project ESP-IDF versions via idf_path parameter.
• SDK config management: supports custom sdkconfig_defaults files for build configuration (multiple files can be specified separated by semicolons).
• Build time tracking for performance monitoring.
• Optional port specification for flashing operations.
• Includes experimental support for automatic issue fixing based on build logs.

Vision & Future Work: The long-term vision is to expand this MCP into a comprehensive toolkit for interacting with embedded devices, potentially integrating with home assistant platforms, and streamlining documentation access for ESP-IDF and related technologies.

We envision features such as:

• Broader ESP-IDF command support (e.g., monitor, menuconfig interaction if feasible).
• Device management and information retrieval.
• Integration with other embedded development tools and platforms.

Your ideas and contributions are welcome! Please feel free to discuss them by opening an issue.

Install

First, clone this MCP repository:

git clone [email protected]:horw/esp-mcp.git

Then, configure it in your chatbot.

The JSON snippet below is an example of how you might configure this esp-mcp server within a chatbot or an agent system that supports the Model Context Protocol (MCP). The exact configuration steps and format may vary depending on the specific chatbot system you are using. Refer to your chatbot’s documentation for details on how to integrate MCP servers.

{
    "mcpServers": {
        "esp-run": { // "esp-run" is an arbitrary name you can assign to this server configuration.
            "command": "",
            "args": [