NSM-DEBUG MCP

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

特性

5分钟设置（推荐）

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

1. 克隆仓库。
2. 创建本地 .venv 在repo根目录中。
3. 将软件包安装到其中 .venv.
4. 打开 NSM-DEBUG_MCP VS Code中的文件夹本身。
5. 在要求VS Code启动MCP服务器之前运行自检。

# 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)

IPv6

Routing Protocols

AC / Wireless

Save & Reset

Built-in Tools (no YAML config needed)

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

独立工具脚本

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

# 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 以获取完整参考。

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配置：

{
  "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+可执行文件。

已验证的环境

项目结构

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 ⭐