docs: Update CN translation for idf-py.rst

This commit is contained in:
Shen Mengjing
2026-03-09 12:18:15 +08:00
committed by Marek Fiala
parent e7e8c09a33
commit e6091afd31
2 changed files with 72 additions and 20 deletions
+1 -1
View File
@@ -275,7 +275,7 @@ The ESP-IDF MCP (Model Context Protocol) server enables AI integration with ESP-
Starting the MCP Server
^^^^^^^^^^^^^^^^^^^^^^^^
To use the MCP server with an AI assistant, configure your agent or IDE to start the server (the sections below show how). You can do that in two ways:
To use the MCP server with an AI assistant, configure your agent or IDE to start the server. You can do that in two ways:
1. Using ``eim run`` (recommended): Use the ESP-IDF Installation Manager (EIM) to start a new process with an active ESP-IDF environment. This feature is available from EIM 0.8.1 and **ESP-IDF must be installed via the EIM installer**. This is the easiest option and does not require you to activate ESP-IDF in your shell first.
+71 -19
View File
@@ -267,44 +267,96 @@ uf2 二进制文件也可以通过 :ref:`idf.py uf2 <generate-uf2-binary>` 生
此命令将打印 ``otadata`` 分区的内容,该分区存储当前所选 OTA 应用程序分区的信息。有关 ``otadata`` 分区的更多信息,请参阅 :doc:`/api-reference/system/ota`
启动 MCP 服务器``mcp-server``
---------------------------------
ESP-IDF MCP 服务器
------------------
ESP-IDF 的 MCPModel Context Protocol,模型上下文协议)服务器可实现 AI 与 ESP-IDF 项目的集成。该 MCP 服务器提供工具和资源,使 AI 助手能够通过标准化协议与 ESP-IDF 项目交互。通过自然语言,即可向 AI 助手下达诸如“设定目标芯片为 esp32”或“构建项目”之类的命令。
启动 MCP 服务器
^^^^^^^^^^^^^^^
要配合 AI 助手使用 MCP 服务器,可配置智能体或 IDE 启动该服务器。具体来说,有两种实现方式:
1. 使用 ``eim run`` (推荐):通过 ESP-IDF 安装管理器 (ESP-IDF Installation Manager, EIM) 在已激活的 ESP-IDF 环境中启动一个新进程。该功能需要 EIM 0.8.1 或更高版本,且 **ESP-IDF 必须通过 EIM 安装程序安装**。该方案是最简单的选项,且无需先在 shell 中激活 ESP-IDF 环境。
.. code-block:: bash
eim run "idf.py mcp-server"
2. 直接使用 ``idf.py``:在已激活 ESP-IDF 环境的 shell 中运行 ``idf.py mcp-server`` 命令启动 MCP 服务器。必须在有效的 ESP-IDF 项目目录中执行该命令,或者使用 ``idf.py -C <project_dir> mcp-server`` 指定项目路径。
.. code-block:: bash
idf.py mcp-server
此命令将启动 MCP(模型上下文协议)服务器,实现 AI 与 ESP-IDF 项目的集成。该服务器通过标准化协议提供工具和资源,使 AI 助手能够与 ESP-IDF 项目进行交互。
.. note::
MCP 服务器提供以下工具:
MCP 服务器需要通过 EIM 安装器来安装 ``mcp`` 功能。有关如何安装特定功能,请参见 `EIM 文档 > CLI 配置 - 全局功能 <https://docs.espressif.com/projects/idf-im-ui/en/latest/cli_configuration.html#global-features-all-versions>`_
- ``build_project``:使用指定目标芯片构建 ESP-IDF 项目
- ``set_target``:设置 ESP-IDF 目标芯片(esp32、esp32s3、esp32c6 等)
- ``flash_project``:将构建好的项目烧录至已连接设备
- ``monitor_serial``:启动串行监视器(在后台运行)
- ``clean_project``:清理构建产物
- ``menuconfig``:打开 menuconfig 界面(基于终端
可用工具与资源
^^^^^^^^^^^^^^
MCP 服务器提供以下可用的命令:
- ``set target``:设置 ESP-IDF 的目标芯片(esp32esp32s3esp32c6 等
- ``build project``:使用当前目标构建 ESP-IDF 项目
- ``flash project``:将已构建的项目烧录到已连接的设备,通过端口名称进行指定。
- ``clean project``:清理构建产物
同时提供以下资源:
- ``project://config``:获取当前项目配置
- ``project://status``:获取当前项目构建状态
- ``project://devices``:获取已连接的 ESP 设备列表
- ``project://status``:获取当前项目构建状态和构建产物
- ``project://devices``:获取已连接的设备列表
.. note::
将 ESP-IDF MCP 服务器添加至 IDE 和 AI 智能体
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
运行 MCP 服务器需提前安装 ``mcp`` Python 包。可通过以下命令安装:``./install.sh --enable-mcp``
Cursor IDE
~~~~~~~~~~
将 ESP-IDF MCP 服务器添加到 IDE
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
将 ESP-IDF MCP 服务器配置添加至 Cursor 的 ``mcp.json`` 文件中:
**Claude Desktop**
.. code-block:: json
使用 Claude CLI 添加 ESP-IDF MCP 服务器:
{
"mcpServers": {
"esp-idf-eim": {
"command": "eim",
"args": [
"run",
"idf.py mcp-server"
],
"env": {
"IDF_MCP_WORKSPACE_FOLDER": "${workspaceFolder}"
}
}
}
}
若想在 Cursor IDE 中使用 ESP-IDF MCP 服务器,请打开 ESP-IDF 项目文件夹并使用 AI 聊天窗口,AI 助手能够访问 ESP-IDF 专用工具,并帮助构建、烧录和管理项目。
MCP 服务器能够通过 ``IDF_MCP_WORKSPACE_FOLDER`` 环境变量确认哪个目录包含 ESP-IDF 项目,确保服务器在正确的项目上下文中运行,使其能够访问项目的配置和构建文件,并在正确的位置执行诸如构建和烧录之类的操作。
Claude 桌面版
~~~~~~~~~~~~~
使用 Claude CLI 添加 ESP-IDF MCP 服务器。
使用 ``eim`` (无需事先激活 ESP-IDF):
.. code-block:: bash
claude mcp add esp-idf python /path/to/esp-idf/tools/idf.py mcp-server --env IDF_PATH=/path/to/esp-idf
claude mcp add --transport stdio esp-idf-eim -- eim run "idf.py mcp-server"
使用 ``idf.py`` (必须在已激活的 ESP-IDF 环境中执行):
.. code-block:: bash
claude mcp add --transport stdio esp-idf -- idf.py mcp-server
前往 ESP-IDF 项目目录,并运行 ``claude`` 命令,与 AI 助手聊天。
配置预设:``--preset``
========================