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

Codex CLI

OpenAI 的 Codex CLI 通过 TOML 配置 文件支持 espctl。格式看起来和 JSON 工具略不一样,但做的事是一样的。

配置

写入 ~/.codex/config.toml(或者项目目录下的 .codex/config.toml 作为项目级):

[mcp_servers.espctl]
command = "/path/to/espctl"
args = ["mcp", "serve"]
cwd = "/path/to/your/esp-idf/project"

[mcp_servers.espctl.env]
CONTROL_BASE_URL = "https://esphome.cloud"
MCP_AUTH_SECRET = "your-access-key"

注意事项:

  • [mcp_servers.espctl.env] 是它自己的一段 TOML 表 —— 每个变量一行。 不要试图嵌入 JSON 风格的 map。
  • args 是一个 TOML 字符串数组,完全按上面写。
  • 路径/值规则和 Claude Code 那一章一样。

看看是不是工作了

重启 Codex CLI(或者重新打开持有它的 shell)。在 Codex 聊天里:

我有哪些 espctl 工具?

应该看到标准的约 40 个工具列表。如果有问题,看 Codex 的调试日志 (通常在 ~/.codex/logs/,或者用 codex --debug 输出到终端)。

Codex 特有注意事项

  • TOML 对表头敏感。两段式格式([mcp_servers.espctl] 然后 [mcp_servers.espctl.env])是稳的写法 —— 把 env 内联成 env = { ... } 在某些 TOML 版本能用,但不一定。
  • Codex CLI 支持项目级 .codex/config.toml,这是你只想在某个固件 项目里启用 espctl 时的自然位置。

提示

问 Codex:

读取 install://codex,把代码片段给我。

…espctl 会返回一段新生成的 TOML 块。