Netbird MCP Server

What is Netbird MCP Server?

Netbird MCP Server is a Model Context Protocol server that exposes select read-only Netbird API resources as tools for LLMs. It allows AI assistants to query information about a Netbird network, such as peers, groups, policies, and posture checks. The server is intended for Netbird users who want to inspect their network configuration through conversational interfaces.

How to use Netbird MCP Server?

Obtain a Netbird API token from the Netbird management console. Install the mcp-netbird binary via go install, building from source, or through Smithery. Add the server configuration to your MCP client (e.g., Windsurf, Claude Desktop) with the token set in the NETBIRD_API_TOKEN environment variable. Optionally set NETBIRD_HOST to change the API endpoint. Then ask the LLM questions about your Netbird network.

Key features of Netbird MCP Server

• Read‑only access to the Netbird API for LLMs
• Configurable API host via NETBIRD_HOST environment variable
• Secure token‑based authentication with NETBIRD_API_TOKEN
• Supports both stdio and SSE transport modes
• Docker image available for SSE deployment
• Integrates with ToolHive for simplified MCP server management

Use cases of Netbird MCP Server

• List all peers in a Netbird network and inspect their status
• Retrieve all groups and policies for network audit or documentation
• List inbound port allocations for a given peer
• Query DNS nameserver groups configured in the network
• Explain network posture checks and overall configuration via a chat interface

FAQ from Netbird MCP Server

What prerequisites are needed to run Netbird MCP Server?

A Netbird API token is required. The mcp-netbird binary must be installed and accessible in the system PATH.

How do I obtain a Netbird API token?

Generate a token from the Netbird management console. See the Netbird API authentication documentation for details.

What transport modes does the server support?

It supports both stdio (default) and SSE (enabled with --transport sse and an optional --sse-address flag).

Can I use a custom Netbird API host?

Yes, set the NETBIRD_HOST environment variable. The default is api.netbird.io.

Is Netbird MCP Server production‑ready?

No. The README states the project is still in development.