| name | serial-debug |
| description | CLI-first serial port debugging and macro automation with serial-mcp-server for Codex and Claude Code. Use when working with UART or USB-serial devices, listing serial ports, probing STM32/Arduino/ESP32 boards, writing or reading serial data, running JSON serial macros, controlling RTS/DTR, or using serial-mcp-server through MCP tools. |
Serial Debug
Operating Rule
Use the serial-mcp-server CLI first unless the user explicitly asks for MCP or an MCP client is already configured. Keep stdout data separate from diagnostics, cite exact commands, and base hardware success on real command evidence from the device.
Workflow
- Confirm the binary is available:
serial-mcp-server --help
- List available ports before choosing a device:
serial-mcp-server list-ports --json
- For a device smoke test, probe the port first, then write/read only when the probe succeeds:
serial-mcp-server probe --port <port> --baud 115200 --json
serial-mcp-server write --port <port> --baud 115200 --data H --read --timeout-ms 1000 --json
- If RTS or DTR is involved, state the requested line levels and use the control-line command:
serial-mcp-server set-control-lines --port <port> --rts high --dtr low --json
- For repeatable serial procedures, prefer JSON macro packs and validate or plan them before real hardware execution:
serial-mcp-server macro validate --file <pack.json> --json
serial-mcp-server macro plan --file <pack.json> --macro <name> --json
serial-mcp-server macro run --file <pack.json> --macro <name> --simulate-read <response> --json
serial-mcp-server macro run --file <pack.json> --macro <name> --port <port> --baud 115200 --json
Macro packs are restricted JSON DSL files. v0.3 supports send, delay, expect contains, expect equals, and assemblies that call macros. It does not support shell commands, language execution, loops, variables, Quick commands, or RTS/DTR macro steps.
References
- Read
references/cli.md for exact command behavior, output expectations, and automation rules.
- Read
references/mcp.md when the user asks for MCP setup or MCP tool usage.
- Read
references/hardware-safety.md before changing baud, wiring, voltage levels, RTS, DTR, or reset/boot lines.
- Read
references/troubleshooting.md when a command fails, times out, returns no ports, or cannot open the device.
Reporting
Report the command, exit status, and the relevant JSON or error excerpt. If no hardware is connected, limit the validation summary to discovery and help paths.
