serial-mcp
v3.0.2
Published
嵌入式 AI 调试串口 MCP 服务,让 Claude Code / Codex CLI 直接读写串口数据
Maintainers
Readme
serial-mcp
嵌入式 AI 调试串口 MCP 服务,让 Claude Code / Codex CLI 直接读写串口数据,实现编码→烧录→调试的完整闭环。当前版本使用 MCP TypeScript SDK v2,并兼容 legacy MCP 客户端。
安装
直接运行(推荐)
无需全局安装,直接运行最新版:
npx -y serial-mcp@latest也可以全局安装:
npm install -g serial-mcp
serial-mcpClaude Code
claude mcp add -s user serial -- cmd /c npx -y serial-mcp@latestCodex CLI
codex mcp add serial -- npx -y serial-mcp@latestMac / Linux
claude mcp add -s user serial -- npx -y serial-mcp@latest验证安装
claude mcp list
# 看到 serial · ✔ connected 即成功使用方式
安装完成后,直接告诉 AI:
我的设备接在 COM5,波特率 115200,帮我连接并开始调试
AI 会自动完成连接,无需任何额外配置。
手动启动
如果不通过 MCP 客户端启动,也可以直接运行:
node server.jslistener 和 monitor 通常由 MCP Server 自动管理,也可以分别运行:
node lib/listener.js
node monitor-window.js COM5 115200功能
| 功能 | 状态 | |------|------| | 串口连接/断开 | ✅ 稳定 | | 数据收发 | ✅ 稳定 | | SQLite 数据持久化 | ✅ 稳定 | | 多串口并发 | ✅ 稳定 | | 设备自动检测 | ✅ 稳定 | | TUI 监控窗口 | ✅ 稳定 | | 定时发送 | ✅ 稳定 | | Modbus RTU | 🚧 开发中 |
MCP 工具列表
| 工具 | 说明 |
|------|------|
| list_ports | 扫描系统所有可用串口 |
| list_connected | 查看当前已接管的串口 |
| connect_port | 接管指定串口 |
| disconnect_port | 释放指定串口 |
| detect_device | 自动检测新插入的串口设备 |
| get_status | 所有串口连接状态 |
| send_data | 向指定串口发送数据 |
| send_and_wait | 发送指令并等待响应 |
| read_latest | 读取最新 N 条数据 |
| read_since | 读取某时间点后的数据 |
| new_session | 烧录后创建新会话 |
| open_monitor | 弹出 TUI 监控窗口 |
监控窗口
AI 调用 open_monitor 工具后会弹出独立的终端监控窗口:
- 实时显示 TX/RX 数据,带时间戳
- 支持直接输入发送(文本/HEX 双模式)
- 定时发送:
/timer 1000 hello\r\n - 斜杠命令:
/hex/text/timers/stop/clear
安全说明
- listener 的 HTTP 接口默认只接受本次启动生成的 bearer token,未授权请求返回
401。 - 串口端口名会按操作系统校验;Windows 使用
COM1、COM12等格式,Linux/macOS 使用受控的/dev/tty*或/dev/cu.*格式。 open_monitor使用参数数组启动 Node 进程,不经过 shell 或临时.bat文件。- token 和 SQLite 数据默认保存在用户目录下的
.serial-mcp文件夹中,请勿将其中的 token 文件提交到仓库或日志。
真实硬件接入
插上设备后告诉 AI:
帮我检测新插入的串口设备
AI 会自动调用 detect_device 识别并连接。
系统要求
- Node.js >= 22(推荐 Node.js 24 LTS x64,兼容 Node.js 22 LTS)
- Windows / Mac / Linux
- 真实硬件或虚拟串口驱动
项目使用 Node.js + npm 运行,不再需要项目级 Visual Studio Build Tools 或 exe/pkg 打包工具。serialport 和 better-sqlite3 在受支持的 Node 22/24 x64 Windows 环境优先使用预编译原生包;若使用不受支持的 Node/平台组合,npm 仍可能回退到本地原生编译。
更新到最新版
查看 npm 最新版本:
npm view serial-mcp version使用最新版运行:
npx -y serial-mcp@latestLicense
MIT © lckandyou
作者
- lckandyou
- GitHub: https://github.com/LckAndLove
