NSM-DEBUG MCP

MCP开发工具

提供方 QianChang-official

开发工具 stdio · 本地进程 会话登录 社区 / 第三方 VS Code
查看接入方式

一个基于MCP协议的串口调试服务器,用于通过VS Code Copilot Agent与网络设备进行交互,无需切换终端窗口。

一句话选型结论

按资料字段整理

NSM-DEBUG MCP 属于开发工具类 MCP 服务器,stdio · 本地进程,会话登录,可直接接入 VS Code,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式stdio · 本地进程 鉴权会话登录 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 29 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量29暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

网络管理Python本地部署串口调试自动化工具VSCode扩展CLI工具

安装与配置

stdio · 本地进程 会话登录
客户端在本机拉起子进程,数据不出本机
python -m pip install --upgrade pip

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Python,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 29 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 29 个工具,覆盖面较广,能满足多种调用。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 VS Code,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好会话登录对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 VS Code 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
NSM-DEBUG MCP当前 29 stdio · 本地进程 本地部署 有 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方QianChang-official上游标注的维护方 QianChang-official
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式会话登录远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Python本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

8.3 KB
来自项目仓库与上游目录的原文,未做删改

NSM-DEBUG_MCP

Network System Management — Debug MCP Server

A Windows-first MCP server for VS Code that turns serial console interactions into AI-callable tools.

📖 English Guide ·
📖 中文教程 ·
🐛 Report Bug ·
💡 Request Feature


它的作用

连接串行电缆,将服务器指向您的设备,并通过VS Code Copilot Agent与网络设备通信——不需要终端窗口切换。```
You (Copilot Chat) → "查看 R1 路由表"
↓
NSM-DEBUG_MCP → serial console → show ip route
↓
Device output → Copilot Chat


## 特性

|类别|能力|
|----------|-----------|
| **会话自动化** |自动登录(用户名/密码/启用),分页禁用|
| **CLI工具** |20+预定义命令:显示、OSPF、BGP、IS-IS、VLAN、DHCP、IPv6|
| **BootLoader重置** |路由器、交换机、AC、网关的自动工厂重置|
| **控制键** |串行上的原始Ctrl+C/Ctrl+B/Ctrl+Q注入|
| **Win32回退** |CH340通过本机Win32 API的USB串行解决方案|
| **YAML配置文件** |每个设备一个配置文件——在几秒钟内交换目标|

## 5分钟设置(推荐)

此存储库首先是Windows。最快的路径是:

1. 克隆仓库。
1. 创建本地 `.venv` 在repo根目录中。
1. 将软件包安装到其中 `.venv`.
1. 打开 `NSM-DEBUG_MCP` VS Code中的文件夹本身。
1. 在要求VS Code启动MCP服务器之前运行自检。```powershell
# 1. Clone
git clone https://github.com/QianChang-official/NSM-DEBUG_MCP.git
cd NSM-DEBUG_MCP

# 2. Create and activate a repo-local virtual environment
py -3 -m venv .venv
.\.venv\Scripts\Activate.ps1

# 3. Install dependencies
python -m pip install --upgrade pip
pip install -e .

# 4. Copy and edit the example config
Copy-Item .\NSM-DEBUG_MCP.example.yaml .\my_device.yaml
# Edit my_device.yaml: set hostname, credentials, COM port

# 5. Verify the server can load and register tools
python .\tools\selftest_list_tools.py

如果自检打印工具名称,例如 run_cli, show_version,以及 send_control_keys,安装已就绪。

然后:

  1. 打开 NSM-DEBUG_MCP 文件夹直接在VS代码中。
  2. 跑 Developer: Reload Window 一次。
  3. 在代理模式下打开Copilot聊天。
  4. 开始 NSM-DEBUG_MCP 如果MCP服务器未自动启动,则从MCP服务器列表中删除。

可用的MCP工具

General (click to expand)

工具 · 命令 · 描述
run_cli · {command} · 执行任何CLI命令
show_version · show version · 设备版本信息
show_running_config · show running-config · 运行配置
show_startup_config · show startup-config · 启动配置
show_ip_interface_brief · show ip interface brief · 接口概述
show_ip_route · show ip route · IPv4路由表
show_vlan · show vlan · VLAN配置
show_mac_address_table · show mac-address-table · MAC地址表
show_lldp_neighbors · show lldp neighbors · LLDP邻居
show_lldp_neighbors_detail · show lldp neighbors detail · LLDP邻居详细信息
show_ip_dhcp_binding · show ip dhcp binding · DHCP租用表
show_privilege · show privilege · 当前特权级别
show_flash · dir flash: · Flash目录
show_interfaces · show interfaces {interface} · 接口详细信息
show_running_include · show running-config \ · include {pattern} · 已筛选配置

IPv6

工具 命令
show_ipv6_interface_brief show ipv6 interface brief
show_ipv6_route show ipv6 route

Routing Protocols

工具 命令
show_ip_ospf_neighbor show ip ospf neighbor
show_ip_bgp_summary show ip bgp summary
show_isis_neighbors show isis neighbors
show_ip_rip_database show ip rip database

AC / Wireless

工具 命令
show_ap_all show ap all
show_ap_config_summary show ap-config summary

Save & Reset

工具 命令
write_memory write memory
save_config save

Built-in Tools (no YAML config needed)

工具 说明
list_serial_ports 列出Windows可见的COM端口,而不打开它们
connection_status 显示已编辑机密的服务器、串行和登录会话状态
send_control_keys 发送原始控制键(Ctrl+C、Ctrl+B、Ctrl+Q…)
auto_factory_reset 自动BootLoader工厂重置工作流程

支持的重置配置文件: router · switch · ws6008 · gateway

独立工具脚本

这 tools/ directory为无头自动化提供了独立的Python脚本(不需要VS代码):

脚本 目的
selftest_list_tools.py 加载配置并打印所有已注册的MCP工具名称
run_r1_ctrlc_ctrlq_factory_reset.py 通过日志记录和验证执行完整的路由器出厂重置
# Run self-test
python tools/selftest_list_tools.py

# Run automated factory reset (outputs to txt/)
python tools/run_r1_ctrlc_ctrlq_factory_reset.py

自检是将Python/安装问题与串行/YAML问题区分开来的最快方法。先运行它。

配置

一个YAML文件控制着一切。看 NSM-DEBUG_MCP.example.yaml 以获取完整参考。```yaml
serial:
port: COM3 # or leave empty for auto-detect
baud_rate: 9600
bytesize: 8
parity: N
stopbits: 1

session:
hostname: R1
username: admin
password: "your_password"
enable_password: "your_enable_password"

commands:
run_cli:
command: "{command}"
need_parse: true
prompts:
- "Execute {command} on the device"


## VS代码集成

存储库已包含 `.vscode/mcp.json`.

重要提示:

- 它假定您创建了 `.venv` 在存储库根目录中。
- 它仅在您打开时自动工作 `NSM-DEBUG_MCP` 文件夹本身作为VS Code工作区。
- 如果您打开父文件夹,VS Code将使用父工作区的 `.vscode/mcp.json`,而不是这个仓库。

等效MCP配置:```json
{
"servers": {
"NSM-DEBUG_MCP": {
"type": "stdio",
"command": "${workspaceFolder}\\.venv\\Scripts\\python.exe",
"args": [
"${workspaceFolder}\\src\\nsm_debug_mcp\\server.py",
"${workspaceFolder}\\NSM-DEBUG_MCP.example.yaml"
]
}
}
}

如果要将此服务器集成到现有的多文件夹工作区中,请复制 NSM-DEBUG_MCP 服务器块进入父工作区 .vscode/mcp.json 并调整克隆位置的路径。

故障排除

MCP服务器未出现在VS代码中

  • 确认您已打开 NSM-DEBUG_MCP 文件夹本身,而不仅仅是其父文件夹。
  • 确认 .venv\Scripts\python.exe 存在于repo根目录中。
  • 跑 python .\tools\selftest_list_tools.py 第一。如果失败,请在调试VS Code之前修复Python或包安装。

MCP服务器存在,但无法启动

  • 重新运行 Developer: Reload Window 创建后 .venv 以及安装依赖项。
  • 检查是否 my_device.yaml 或 NSM-DEBUG_MCP.example.yaml 包含正确的COM端口和提示设置。
  • 如果使用CH340串行适配器,请在调试MCP之前验证Windows设备管理器中是否存在COM端口。

从现有PowerShell会话安装失败

  • 跑 Set-ExecutionPolicy -Scope Process RemoteSigned 如果PowerShell阻止 .venv\Scripts\Activate.ps1.
  • 如果 py -3 不可用,请将其替换为可用的Python 3.11+可执行文件。

已验证的环境

组件 版本
操作系统 Windows
Python 3.14
VS代码 最新+GitHub Copilot聊天代理模式
串行适配器 COM3上的CH340
目标设备 瑞杰RSR20-X、S5310、S5760、WS6008、EG3210
串行设置 9600 8N1 XON/XOFF

项目结构```

NSM-DEBUG_MCP/
├── src/nsm_debug_mcp/ # MCP server implementation
│ ├── init.py # Package entry point
│ └── server.py # Core server logic
├── tools/ # Standalone automation scripts
├── markdown/ # Documentation (EN/ZH)
├── .vscode/mcp.json # VS Code MCP launch config
├── NSM-DEBUG_MCP.example.yaml # Unified example configuration
├── pyproject.toml # Python package metadata
└── LICENSE # MIT License
```

致谢

  • 基于 MCP2系列 概念
  • GPT辅助重构和真实设备适配
  • 在生产实验室环境中对瑞杰网络设备进行了测试

许可证

麻省理工学院 --免费用于个人和商业用途。


If this project helped you, consider giving it a ⭐

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
NSM-DEBUG MCP 怎么安装?

在客户端按下面的安装命令接入:python -m pip install --upgrade pip。装完在客户端配置里引用同一个包或端点。

NSM-DEBUG MCP 怎么在 VS Code 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

NSM-DEBUG MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

NSM-DEBUG MCP 需要 API Key 吗?

资料标注需要会话登录认证,使用前准备好对应凭据,并按最小权限配置。

NSM-DEBUG MCP 支持哪些客户端?

资料标注支持 VS Code;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

NSM-DEBUG MCP 能提供哪些能力?

资料显示约 29 个工具;能力标签包括 网络管理、Python、VS Code、命令行工具。具体工具清单以官方文档为准。

NSM-DEBUG MCP 需要什么运行环境?

运行时为 Python;属于本地进程,需要在本机装好运行环境。

NSM-DEBUG MCP 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。