Netbird MCP 服务器

一个用于 Netbird 的 模型上下文协议 (MCP) 服务器。

本项目衍生自 Grafana Labs 的 Grafana MCP 服务器，并采用相同的 Apache License 2.0 许可。

注意：本项目仍在开发中。

从源码安装

克隆仓库

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)

功能

• [x] 列出包含详细信息的 Netbird 对等节点
  • 连接状态
  • 位置信息
  • 系统详情
  • 群组成员
• [x] 可配置的 API 端点
• [x] 安全的基于令牌的身份验证

工具

工具	类别	描述
list_netbird_peers	对等节点	列出你的 Netbird 网络中的所有对等节点
list_netbird_groups	群组	列出你的 Netbird 网络中的所有群组
list_netbird_policies	策略	列出你的 Netbird 网络中的所有策略

用法

1. 从 Netbird 管理控制台获取你的 Netbird API 令牌。

2. 使用上述安装方法之一安装 mcp-netbird 二进制文件。 确保该二进制文件位于你的 PATH 中。

3. 将服务器配置添加到你的客户端配置文件。 例如，对于 Codeium Windsurf，将以下内容添加到 ~/.codeium/windsurf/mcp_config.json：

   {
     "mcpServers": {
       "netbird": {
         "command": "mcp-netbird",
         "args": [],
         "env": {
           "NETBIRD_API_TOKEN": "<你的 API 令牌>"
         }
       }
     }
   }
   

有关如何将类似配置添加到 Claude Desktop 的更多信息，请参见 此处。

注意：如果在 Claude Desktop 日志中看到类似 [netbird] [error] spawn mcp-netbird ENOENT 的内容，则需要指定 mcp-netbird 的完整路径。 在 macOS 上，Claude 日志位于 ~/Library/Logs/Claude 中。

4. 尝试提出类似“你能向我解释我的 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 服务器。

测试

TODO: 添加测试

代码检查

要检查代码，请运行：

make lint

许可证

本项目采用 Apache License, Version 2.0 许可。

本项目包含在 Grafana Labs (https://grafana.com/) 开发的软件。