- Netbird
Netbird
Netbird MCP Server
A Model Context Protocol (MCP) server for Netbird.
This project is derived from the MCP Server for Grafana by Grafana Labs and is licensed under the same Apache License 2.0.
Note: this project is still in development and may not work as expected.
Installation
From Source
# Clone the repository
git clone https://github.com/aantti/mcp-netbird
cd mcp-netbird
# Build and install
make install
From GitHub
go install github.com/aantti/mcp-netbird/cmd/mcp-netbird@latest
Configuration
The server requires the following environment variables:
NETBIRD_API_TOKEN: Your Netbird API tokenNETBIRD_HOST(optional): The Netbird API host (default isapi.netbird.io)
Features
- List Netbird peers with detailed information
- Connected status
- Location information
- System details
- Group membership
- Configurable API endpoint
- Secure token-based authentication
Tools
| Tool | Category | Description |
|---|---|---|
list_netbird_peers | Peers | List all peers in your Netbird network |
Usage
-
Get your Netbird API token from the Netbird management console.
-
Install the
mcp-netbirdbinary using one of the installation methods above. -
Add the server configuration to your client configuration file. For example, for Claude Desktop:
{ "mcpServers": { "netbird": { "command": "mcp-netbird", "args": [], "env": { "NETBIRD_API_TOKEN": "<your-api-token>" } } } }
Note: if you see
Error: spawn mcp-netbird ENOENTin Claude Desktop, you need to specify the full path tomcp-netbird.
Development
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
This project is written in Go. Install Go following the instructions for your platform.
To run the server manually, use:
NETBIRD_API_TOKEN=your-token make run
Or in SSE mode:
NETBIRD_API_TOKEN=your-token make run-sse
Testing
TODO: add tests
Linting
To lint the code, run:
make lint
License
This project is licensed under the Apache License, Version 2.0.
This project includes software developed at Grafana Labs (https://grafana.com/).
Server Config
{
"mcpServers": {
"netbird": {
"command": "mcp-netbird",
"args": [],
"env": {
"NETBIRD_API_TOKEN": "your-token-here"
}
}
}
}