aantti_mcp_netbird
by aanttiNetbird MCP Server: Enhancing Netbird with Model Context Protocol
Overview
The Netbird MCP Server is a specialized implementation of the Model Context Protocol (MCP) designed to integrate seamlessly with Netbird. This project, derived from the MCP Server for Grafana by Grafana Labs, extends Netbird's capabilities by providing detailed insights into peers, groups, and policies within your Netbird network.
Features
- Peer Management: List Netbird peers with detailed information, including connected status, location, system details, and group membership.
- Configurable API Endpoint: Customize the Netbird API host for flexible deployment.
- Secure Authentication: Utilize token-based authentication for secure access.
Tools
| Tool | Category | Description |
|---|---|---|
list_netbird_peers |
Peers | List all peers in your Netbird network |
list_netbird_groups |
Groups | List all groups in your Netbird network |
list_netbird_policies |
Policies | List all policies in your Netbird network |
Installation
From Source
- Clone the Repository:
shell git clone https://github.com/aantti/mcp-netbird - Build and Install:
shell cd mcp-netbird && 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 token.
- NETBIRD_HOST (optional): The Netbird API host (default is api.netbird.io).
Usage
- Obtain your Netbird API token from the Netbird management console.
- Install the
mcp-netbirdbinary and ensure it is in your PATH. - Add the server configuration to your client configuration file. For example, for Codeium Windsurf:
json { "mcpServers": { "netbird": { "command": "mcp-netbird", "args": [], "env": { "NETBIRD_API_TOKEN": "<your-api-token>" } } } } - Start querying your Netbird network with questions like, "Can you explain my Netbird peers, groups, and policies to me?"
Development
Contributions are welcome! The project is written in Go. To run the server manually:
export NETBIRD_API_TOKEN=your-token && go run cmd/mcp-netbird/main.go
Or in SSE mode:
export NETBIRD_API_TOKEN=your-token && go run cmd/mcp-netbird/main.go --transport sse --sse-address :8001
Debugging
Use the MCP Inspector for testing and debugging:
export NETBIRD_API_TOKEN=your-token && npx @modelcontextprotocol/inspector
Testing
TODO: Add tests
Linting
To lint the code:
make lint
License
This project is licensed under the Apache License, Version 2.0.
About
The Netbird MCP Server is a powerful tool for enhancing Netbird's functionality through the Model Context Protocol. For more details, visit the GitHub repository.
Invite Gmail Contacts
