Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Cursor

Cursor 通过 .cursor/mcp.json 中的 mcpServers 字段支持 espctl。

配置

写入工作区的 .cursor/mcp.json,或者 ~/.cursor/mcp.json 让 espctl 在所有 Cursor 工作区中可用:

{
  "mcpServers": {
    "espctl": {
      "command": "/path/to/espctl",
      "args": ["mcp", "serve"],
      "cwd": "/path/to/your/esp-idf/project",
      "env": {
        "CONTROL_BASE_URL": "https://esphome.cloud",
        "MCP_AUTH_SECRET": "your-access-key"
      }
    }
  }
}

每个字段填什么:

  • command —— espctl 程序的完整路径。
  • cwd —— Cursor 应该操作的 ESP-IDF 项目的完整路径。
  • CONTROL_BASE_URL + MCP_AUTH_SECRET —— 两个都留空就是仅计划模式; 两个都设就是远程构建。

看看是不是工作了

重启 Cursor。打开聊天面板问:

你有哪些 espctl 工具?

应该看到和其他 AI 工具一样的约 40 个工具。如果没有,看 Cursor 的 MCP 日志面板(通常在 “Output → MCP”)查看 espctl 实际打印的错误。

Cursor 特有注意事项

  • Cursor 的 MCP 支持是工作区级的,所以项目级 .cursor/mcp.json 是 最常见的方式。
  • 如果你把 Cursor 锁到某个特定 shell(例如 fish),确保该 shell 知道 你依赖的环境变量,或者把它们全部直接列在 env 块里。

提示

只要某个 AI 工具接通了,就可以问它:

读取 install://cursor 资源。

…espctl 会返回一份新生成的、按你机器定制的代码片段。