ESP-IDF for Clion 文档 Help

MCP 工具

插件会向 CLion 内置的 MCP 服务(JetBrains MCP Server)注册一组 MCP 工具, 使外部 AI 客户端(如接入 MCP 的对话助手)能够在无头环境下复用插件的能力: 执行任务树上的命令、获取项目构建环境信息、查询可用串口等。

这些工具与插件界面「任务树」点击执行的路径完全一致,因此 MCP 触发的结果与在 IDE 里手动运行一致。

工具一览

工具名

用途

espidf_list_tasks

列出当前项目可运行的 ESP-IDF 任务

espidf_run_task

按名称运行某个 ESP-IDF 任务

espidf_get_project_info

获取项目的构建环境信息(环境变量脚本、配置等)

espidf_list_serial_ports

列出当前机器上可用的串口

espidf_list_tasks

列出所有可以通过 espidf_run_task 执行的 ESP-IDF 任务(交互式终端 / TUI 类任务会被排除)。

返回每个任务的:

  • id :任务标识(可作为 espidf_run_tasktask 参数)

  • 显示名(display name)

  • 描述

对于使用串口监视器(use-monitor=true )的任务,会在条目后追加 [monitor] 标记,提示该任务支持通过 espidf_run_taskmonitorWaitSeconds 参数采集一段时间的日志。

参数

参数

类型

必填

说明

projectPath

string

目标项目基目录绝对路径;多项目打开时用于定位项目,通常可省略

espidf_run_task

按名称运行任意非交互式 ESP-IDF 任务(build、flash、size、自定义命令等)。

task 参数接受任务的 id 、显示名或完整路径(大小写不敏感),例如 "Build""flash/Flash"。 可先调用 espidf_list_tasks 获取可用任务名。

普通命令类任务会在结束后返回其输出与退出码; 串口监视类(use-monitor=true )任务默认仅触发、不采集输出,其输出在 IDE 控制台查看。

参数

参数

类型

必填

说明

task

string

要运行的 ESP-IDF 任务名称(id / 显示名 / 完整路径,大小写不敏感)

monitorWaitSeconds

integer

仅对 use-monitor=true 的任务有效:采集串口监视输出持续的秒数。省略则仅触发任务、不采集输出;对非监视类任务无效

projectPath

string

目标项目基目录绝对路径;多项目打开时建议填写

示例

{ "task": "monitor", "monitorWaitSeconds": 10 }

上述调用会在约 10 秒内采集串口监视日志后返回(监视进程仍在 IDE 控制台中继续运行)。

espidf_get_project_info

返回当前项目的关键信息,供 MCP 客户端在无头环境下复用与界面一致的构建环境:

  • 项目名称与基目录

  • 当前选中的 CMake Profile、Target、构建目录

  • 关联的工具链(Toolchain)名称及其环境变量导出脚本路径 (客户端可自行 source 该脚本以获得完整构建环境变量,如果不是特别关注每个任务输出,也可以令Ai Agent通过环境变量脚本加命令行操作,实现更灵活的文本处理。

  • 项目级配置:串口、监视波特率、下载波特率、CMake Profile

参数

参数

类型

必填

说明

projectPath

string

目标项目基目录绝对路径;多项目打开时用于定位项目,通常可省略

espidf_list_serial_ports

列出当前机器上可用的串口,便于为烧录 / 监视选择 ESPPORT

串口是机器级资源,与具体项目无关,因此该工具不需要 projectPath 参数。

返回每个串口的:

  • 端口路径 / 名称

  • 描述信息(descriptivePortName、portDescription)

  • 对于可识别的 USB 串口,还会返回厂商 / 产品信息 (vendorId、productId、vendorName、productName)

参数 :无。

使用前提

  1. 在 CLion 中启用 JetBrains MCP Server(CLion 内置 MCP 服务)。

  2. 将本插件注册的工具暴露给外部 AI 客户端。

  3. 当存在多个打开的项目时,通过 projectPath 明确指定目标项目。

其他说明

和本插件提供的工具无关,clion自带mcp工具中 xdebug_start_debugger_session可以启动 本插件提供的ESP-IDF Debug运行配置,用于调试。

16 七月 2026