使用说明

项目简介

Netbird MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当 LLM 客户端和 Netbird 网络管理平台之间的桥梁。通过提供对 Netbird 资源的标准化访问和工具调用,此服务器使得 LLM 能够理解和利用 Netbird 平台的上下文信息,从而实现更智能的网络管理和自动化任务。

主要功能点

  • Netbird 资源访问: 提供对 Netbird peers(节点)、groups(用户组)、policies(策略)和 networks(网络)等核心资源的访问能力,允许 LLM 获取最新的网络配置和状态信息。
  • 工具集成: 预置了多个工具,例如 'list_netbird_peers', 'list_netbird_groups', 'list_netbird_policies', 'list_netbird_networks',使 LLM 可以通过调用这些工具来检索 Netbird 的数据。
  • 可扩展性: 允许开发者添加新的工具,以扩展服务器的功能,满足更丰富的 LLM 应用场景需求。
  • 多种传输协议支持: 支持 Stdio 和 SSE 两种传输协议,方便与不同的 MCP 客户端集成。
  • 安全认证: 通过 Netbird API Token 进行身份验证,保障数据访问安全。

安装步骤

方法一:从源代码安装

  1. 克隆代码仓库
    git clone https://github.com/aantti/mcp-netbird
  2. 构建和安装
    cd mcp-netbird && make install

方法二:从 GitHub 安装

go install github.com/aantti/mcp-netbird/cmd/mcp-netbird@latest

安装完成后,请确保 'mcp-netbird' 命令在您的 PATH 环境变量中可用。

服务器配置

要将 Netbird MCP Server 集成到 MCP 客户端,您需要在客户端的配置文件中指定服务器的启动方式。以下是一个 Codeium Windsurf 客户端的配置示例,配置信息应添加到 '~/.codeium/windsurf/mcp_config.json' 文件中:

{
  "mcpServers": {
    "netbird": {
      "command": "mcp-netbird",
      "args": [],
      "env": {
        "NETBIRD_API_TOKEN": "<your-api-token>"  // 请替换为您的 Netbird API Token
      }
    }
  }
}

配置参数说明:

  • 'command': 指定启动 Netbird MCP Server 的命令,这里设置为 'mcp-netbird'。
  • 'args': 启动命令的参数列表,当前配置为空,表示没有额外参数。
  • 'env': 环境变量配置,'NETBIRD_API_TOKEN' 是必需的环境变量,用于存储您的 Netbird API Token,请务必替换 '<your-api-token>' 为您真实的 Token。您可以从 Netbird 管理控制台获取 API Token。

基本使用方法

  1. 获取 Netbird API Token: 登录 Netbird 管理控制台,获取用于 API 访问的 Token。
  2. 安装 Netbird MCP Server: 按照上述安装步骤选择一种方式安装 'mcp-netbird'。
  3. 配置 MCP 客户端: 修改 MCP 客户端的配置文件(如 '~/.codeium/windsurf/mcp_config.json'),添加上述服务器配置,并填入您的 Netbird API Token。
  4. 在 LLM 中使用: 现在您可以向配置了 MCP 客户端的 LLM 提出关于 Netbird 网络的问题。例如,您可以询问:“我的 Netbird 网络中有哪些 peers?” 或 “Netbird 的安全策略是什么?”,LLM 将通过 Netbird MCP Server 获取 Netbird 的数据并给出回答。

信息

分类

AI与计算