MCP Netbird服务器
识别到的语言类型为英文。 MCP服务器用于Netbird
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"netbird": {
"args": [],
"command": "mcp-netbird",
"env": {
"NETBIRD_API_TOKEN": "\u003cyour-api-token\u003e"
}
}
}
}
该服务需要配置环境变量:NETBIRD_API_TOKEN、NETBIRD_HOST
服务介绍
Netbird MCP 服务器
一个用于 Netbird 的 模型上下文协议 (MCP) 服务器。
该项目源自 Grafana Labs 的 Grafana 的 MCP 服务器,并使用相同的 Apache License 2.0 许可证。
它还使用了 Mark III Labs 的 MCP Go。
注意:此项目仍在开发中。
从源代码安装
克隆仓库
git clone https://github.com/aantti/mcp-netbird
构建和安装
cd mcp-netbird && \
make install
从 GitHub 安装
go install github.com/aantti/mcp-netbird/cmd/mcp-netbird@latest
配置
服务器需要以下环境变量:
NETBIRD_API_TOKEN:您的 Netbird API 令牌NETBIRD_HOST(可选):Netbird API 主机(默认为api.netbird.io)
功能
- 列出带有详细信息的 Netbird 对等点
- 连接状态
- 位置信息
- 系统详情
- 组成员身份
- 可配置的 API 端点
- 基于令牌的安全认证
工具
| 工具 | 类别 | 描述 | Netbird API |
|---|---|---|---|
list_netbird_peers |
对等点 | 所有 Netbird 对等点 | 列出所有对等点 |
list_netbird_groups |
组 | 所有 Netbird 组 | 列出所有组 |
list_netbird_policies |
策略 | 所有 Netbird 策略 | 列出所有策略 |
list_netbird_networks |
网络 | 所有 Netbird 网络 | 列出所有网络 |
添加工具
要添加新工具:
- 在
tools目录下创建一个新的文件(例如,tools/users.go),可能可以使用现有的代码作为模板。 - 在新文件中添加 API 路由和响应的具体内容。
- 在
cmd/main.go中的func newServer()函数里添加该工具。
使用方法
-
从 Netbird 管理控制台获取您的 Netbird API 令牌。
-
使用上述安装方法之一安装
mcp-netbird二进制文件。确保该二进制文件在您的 PATH 中。 -
将服务器配置添加到客户端配置文件中。例如,对于 Codeium Windsurf,在
~/.codeium/windsurf/mcp_config.json中添加以下内容:{ "mcpServers": { "netbird": { "command": "mcp-netbird", "args": [], "env": { "NETBIRD_API_TOKEN": "<your-api-token>" } } } }
有关如何将类似配置添加到 Claude Desktop 的更多信息,请参阅这里。
注意:如果您在 Claude Desktop 日志中看到类似于
[netbird] [error] spawn mcp-netbird ENOENT的内容,您需要指定mcp-netbird的完整路径。在 macOS 上,Claude 日志位于~/Library/Logs/Claude。
- 尝试询问类似“你能向我解释我的 Netbird 对等点、组和策略吗?”的问题。
开发
欢迎贡献!如果您有任何建议或改进,请打开一个 issue 或提交一个 pull request。
该项目使用 Go 语言编写。请根据您的平台安装 Go。
要手动运行服务器,请使用:
export NETBIRD_API_TOKEN=your-token && \
go run cmd/mcp-netbird/main.go
或者在 SSE 模式下:
export NETBIRD_API_TOKEN=your-token && \
go run cmd/mcp-netbird/main.go --transport sse --sse-address :8001
调试
MCP Inspector 是一个用于测试和调试 MCP 服务器的交互式开发者工具。更多详情请参阅 这里。
以下是启动 MCP Inspector 的方法:
export NETBIRD_API_TOKEN=your-token && \
npx @modelcontextprotocol/inspector
然后,您可以使用 stdio 或 SSE 传输类型来测试 Netbird MCP 服务器。对于 stdio,请在 UI 中指定 mcp-netbird 的完整路径。
测试
TODO: 添加测试
代码检查
要进行代码检查,请运行:
make lint
许可证
本项目采用 Apache License, Version 2.0 许可证。
本项目包含由 Grafana Labs 开发的软件 (https://grafana.com/)。