Netbird MCP Server logo

Netbird MCP Server

by aantti

Netbird MCP Server is a Model Context Protocol (MCP) server for Netbird, allowing LLMs to access information about your Netbird network. It leverages the Netbird API to provide read-only access to network configuration and status.

View on GitHub

Last updated: N/A

What is Netbird MCP Server?

Netbird MCP Server is an MCP server that exposes Netbird network information to Large Language Models (LLMs) via the Model Context Protocol. This allows LLMs to understand and interact with your Netbird network configuration and status.

How to use Netbird MCP Server?

  1. Obtain a Netbird API token. 2. Install the mcp-netbird binary. 3. Configure your LLM client (e.g., Codeium Windsurf or Claude Desktop) to use the server, providing the API token as an environment variable. 4. Query the LLM about your Netbird network.

Key features of Netbird MCP Server

  • Uses Netbird API to access configuration and status

  • Configurable API endpoint

  • Secure token-based authentication for Netbird API

  • Provides tools for listing peers, port allocations, groups, policies, posture checks, networks, and nameservers

Use cases of Netbird MCP Server

  • Allowing LLMs to answer questions about your Netbird network configuration

  • Automating network management tasks through LLM interaction

  • Providing context to LLMs for security analysis and troubleshooting

  • Integrating Netbird network information into LLM-powered applications

FAQ from Netbird MCP Server

What is MCP?

Model Context Protocol is a standard for providing context to LLMs.

Where do I get a Netbird API token?

From the Netbird management console.

How do I add new tools?

Create a new file in the tools directory, add API route and response specifics, and add the tool to func newServer() in cmd/main.go.

What if I see spawn mcp-netbird ENOENT in Claude Desktop logs?

You need to specify the full path to the mcp-netbird binary in the client configuration.

How can I debug the server?

Use the MCP Inspector tool to test and debug the server with either stdio or SSE transport type.