Nb MCP Beta

NetBeez MCP服务器

一个模型上下文协议（MCP）服务器，将LLM客户端（Cursor、Claude Desktop等）连接到 NetBeez 的 网络监控平台。支持人工智能辅助的网络故障排除、监控分析和事件调查。

特性

• 32工具 用于查询和管理代理、代理组、目标、测试、计划测试模板、警报、事件、WiFi配置文件、统计数据、路径分析，以及运行ad-hoc Iperf/sepeed/VoIP/自定义命令测试（包括多代理运行状态）
• 5资源 向LLM提供NetBeez数据模型知识、交叉代理关联方法、故障排除工作流程、完整的API参考资料和特别测试指南
• 5个提示模板 对于常见工作流：排除目标故障、分析代理运行状况、调查事件、网络概述、运行即席测试
• 双重运输：stdio（用于Cursor/Claude Desktop）和HTTP（用于远程客户端）

快速入门（推荐）

运行一行安装程序——它处理一切：Node.js、依赖关系、构建、凭据和MCP客户端配置：

curl -fsSL https://raw.githubusercontent.com/netbeez/nb-mcp-server/main/install.sh | bash

安装程序将提示您：

1. 你的 NetBeez实例URL （例如。 https://demo1.netbeezcloud.net)
2. 你的 API密钥 （来自仪表板→ 设置→ API密钥）
3. SSL 验证 首选项（对于自签名证书禁用）
4. 哪个 MCP客户端 配置（光标、克劳德桌面、Windsurf、Codex、Kiro）

该脚本是幂等的——随时重新运行它以更新到最新版本或更改配置。

开发安装（无需git推送）

从该仓库的克隆中，使用以下命令运行安装程序 --dev 将Cursor、Claude Desktop、Codex、Windsurf和Kiro指向您的本地版本：

./install.sh --dev
# or from anywhere:
bash ~/path/to/nb-mcp-server/install.sh --dev

做 不 使用 cat install.sh | bash --这样脚本就不会接收任何参数 --dev 被忽略。

这跳过了克隆；它使用当前目录，运行 npm install 和 npm run build，然后配置相同的MCP客户端以使用 ./dist/index.js。更改后，运行 npm run build 并重新启动客户端——无需推送到git进行测试。

安装程序的作用

先决条件

如果您更喜欢手动安装，则需要：

• Node.js 18+
• 具有API访问权限的NetBeez BeezKeeper实例
• API键（仪表板→ 设置→ API密钥）

单行安装程序只需要Node.js 18+和curl（无git）。

手动安装

1.下载并构建

curl -fsSL https://github.com/netbeez/nb-mcp-server/archive/refs/heads/main.tar.gz -o nb-mcp-server.tar.gz
tar -xzf nb-mcp-server.tar.gz && cd nb-mcp-server-main
npm install
npm run build

2.配置

复制示例环境文件并填写您的值：

cp .env.example .env

编辑 .env:

NETBEEZ_BASE_URL=https://your-instance.netbeezcloud.net
NETBEEZ_API_KEY=your-api-key-here

3.跑步

npm start

MCP客户端配置

光标

添加到光标MCP设置(~/.cursor/mcp.json):

{
  "mcpServers": {
    "netbeez": {
      "command": "node",
      "args": ["~/.netbeez-mcp/dist/index.js"],
      "env": {
        "NETBEEZ_BASE_URL": "https://your-instance.netbeezcloud.net",
        "NETBEEZ_API_KEY": "your-api-key-here"
      }
    }
  }
}

克劳德桌面

添加到您的Claude桌面配置(~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "netbeez": {
      "command": "node",
      "args": ["~/.netbeez-mcp/dist/index.js"],
      "env": {
        "NETBEEZ_BASE_URL": "https://your-instance.netbeezcloud.net",
        "NETBEEZ_API_KEY": "your-api-key-here"
      }
    }
  }
}

帆板运动

添加到您的Windsurf MCP配置(~/.codeium/windsurf/mcp_config.json):

{
  "mcpServers": {
    "netbeez": {
      "command": "node",
      "args": ["~/.netbeez-mcp/dist/index.js"],
      "env": {
        "NETBEEZ_BASE_URL": "https://your-instance.netbeezcloud.net",
        "NETBEEZ_API_KEY": "your-api-key-here"
      }
    }
  }
}

法典

添加到您的Codex配置(~/.codex/config.json):

{
  "mcpServers": {
    "netbeez": {
      "command": "node",
      "args": ["~/.netbeez-mcp/dist/index.js"],
      "env": {
        "NETBEEZ_BASE_URL": "https://your-instance.netbeezcloud.net",
        "NETBEEZ_API_KEY": "your-api-key-here"
      }
    }
  }
}

基罗

添加到您的Kiro用户MCP配置(~/.kiro/settings/mcp.json):

{
  "mcpServers": {
    "netbeez": {
      "command": "node",
      "args": ["~/.netbeez-mcp/dist/index.js"],
      "env": {
        "NETBEEZ_BASE_URL": "https://your-instance.netbeezcloud.net",
        "NETBEEZ_API_KEY": "your-api-key-here"
      }
    }
  }
}

Kiro还支持工作区级别的MCP配置 .kiro/settings/mcp.json.

提示： 安装程序(curl | bash 上面）会自动写入这些配置文件。

更新

重新运行安装程序以获取最新版本并重新生成：

curl -fsSL https://raw.githubusercontent.com/netbeez/nb-mcp-server/main/install.sh | bash

您现有的凭据将显示为默认值——按Enter键保留它们。

如果您安装了 --dev，跑 npm run build 在仓库中，重新启动MCP客户端以获取更改。

卸载

rm -rf ~/.netbeez-mcp

然后移除 "netbeez" 从MCP客户端配置文件中输入。

环境变量

工具（32）

代理工具（6）

代理组工具（4）

目标工具（6）

测试和结果工具（3）

预定测试工具（5）

警报和事故工具（2）

统计工具（3）

临时和其他（3）

资源（5）

提示（5）

发展

# Build
npm run build

# Watch mode
npm run dev

# Test with MCP Inspector
npm run inspect

建筑

src/
├── index.ts                  # Entry point, transport setup
├── server.ts                 # MCP server definition, registration
├── config.ts                 # Environment variable loading
├── api/
│   ├── base-client.ts        # Shared HTTP client (fetch, retries, errors)
│   ├── jsonapi-client.ts     # JSON:API client (Bearer auth, filters, pagination)
│   ├── legacy-client.ts      # Legacy API client (API-VERSION v1)
│   └── types.ts              # TypeScript types for all entities
├── tools/
│   ├── agents.ts             # Agent tools (6)
│   ├── agent-groups.ts       # Agent group tools (4)
│   ├── targets.ts            # Target tools (6)
│   ├── tests.ts              # Test tools (2)
│   ├── incidents.ts          # Incident tools (1)
│   ├── alerts.ts             # Alert tools (1)
│   ├── wifi.ts               # WiFi tools (1)
│   ├── scheduled-tests.ts    # Scheduled test template & results tools (5)
│   ├── statistics.ts         # Statistics tools (3)
│   ├── path-analysis.ts      # Path analysis tools (1)
│   ├── actions.ts            # Ad-hoc test tools (2): run_adhoc_test, get_multiagent_test_run_status
│   └── ad-hoc.ts             # Re-exports actions for ad-hoc tests
├── resources/
│   ├── data-model.ts         # Entity relationships and data shapes
│   ├── correlation-guide.ts  # Cross-agent correlation patterns
│   ├── troubleshooting-guide.ts
│   ├── api-reference.ts      # API endpoint reference
│   └── ad-hoc-tests.ts       # Ad-hoc tests payloads and result parsing guide
└── prompts/
    ├── troubleshoot-target.ts
    ├── analyze-agent-health.ts
    ├── investigate-incident.ts
    ├── network-overview.ts
    └── run-adhoc-test.ts

API覆盖范围

服务器与两个NetBeez API层通信：

• JSON：API （主要）：使用的所有实体和关系端点 Authorization: Bearer 身份验证。支持过滤、分页、包含和排序。
• 传统API：三个统计端点(nb_test_statistics, nb_agent_statistics, access_point_metrics)使用 Authorization: + API-VERSION: v1 标题。

许可证

麻省理工学院