Overview
What is Netbird MCP Server?
Netbird MCP Server is a Model Context Protocol (MCP) server that provides LLMs with read-only access to a Netbird network configuration and status. It uses the Netbird API to expose a set of tools for querying peers, groups, policies, posture checks, networks, nameserver groups, and port allocations. It is intended for developers and administrators who want to interact with Netbird through AI assistants.
How to use Netbird MCP Server?
Install the mcp-netbird binary from source, via go install, or through Smithery. Set the NETBIRD_API_TOKEN environment variable (and optionally NETBIRD_HOST). Add the server configuration (command: mcp-netbird, with the token as an env variable) to your MCP client’s config file (e.g., ~/.codeium/windsurf/mcp_config.json for Windsurf). Then ask the assistant questions about your Netbird network, such as “Can you explain my Netbird peers, groups and policies to me?”.
Key features of Netbird MCP Server
- Token‑based authentication with the Netbird API
- Configurable API endpoint (default
api.netbird.io) - Read‑only tool mapping of several Netbird API resources
- Supports both stdio and SSE transport modes
- Can be deployed via Docker or ToolHive
Use cases of Netbird MCP Server
- Query all peers in a Netbird network from an AI chat
- List groups, policies, and posture checks for security review
- Retrieve DNS nameserver group configurations
- Inspect ingress port allocations for a specific peer
- Get an overview of network definitions without using the web console
FAQ from Netbird MCP Server
What does Netbird MCP Server do?
It exposes read‑only Netbird API endpoints as MCP tools so that LLMs can fetch information about peers, groups, policies, posture checks, networks, nameserver groups, and port allocations.
How do I install Netbird MCP Server?
You can install it from source (make install), via go install, or automatically through Smithery. Docker images can also be built and run.
What are the runtime requirements?
Netbird MCP Server requires Go (if building from source) and a valid Netbird API token. It runs as a binary and can be invoked via stdio or SSE.
Where does the data come from?
All data is retrieved live from the Netbird API. No local data storage is used; the server acts as a passthrough.
What transport protocols are supported?
The server supports both stdio (default) and SSE transport. SSE mode is enabled with the --transport sse flag and a bind address (e.g., :8001). Docker and ToolHive deployments also support SSE.
