Netbird

The Netbird MCP Server is a server based on the Model Context Protocol that provides an interface for LLMs to access the configuration and status of the Netbird network.

Developer tools Security #Network management #API service #MCP protocol .Go

rating : 2.5 points

downloads : 42

update time : 2025-04-28

What is the Netbird MCP Server?

The Netbird MCP Server is a server based on the Model Context Protocol (MCP) that provides information about your Netbird network to language models through the Netbird API. You can use it to understand network configurations, policies, groups, etc. in Netbird.

How to use the Netbird MCP Server?

To start using the Netbird MCP Server, install it and add relevant information to the configuration file. Then, you can ask the language model questions about your Netbird network, such as 'What are my Netbird peers, groups, and policies?'

Applicable scenarios

The Netbird MCP Server is suitable for professionals who need to quickly understand the Netbird network configuration, such as network administrators and technical support staff.

Main features

Support for multiple Netbird API resourcesAccess information such as network configurations, peers, groups, and policies through the Netbird API.

Flexible API endpointsAllow users to customize API endpoints to meet different deployment requirements.

Secure authentication mechanismUse token-based authentication to ensure secure access to the Netbird API.

Advantages and limitations

Advantages

Directly obtain network status and configuration through the Netbird API.

Support multiple tools and API calls.

Easy to integrate into existing language models.

Limitations

Currently only supports read operations for Netbird.

Requires a valid Netbird API token to run.

How to use

Install the Netbird MCP Server

You can install it by building from source code, installing from GitHub, or using Smithery.

Configure environment variables

Set the NETBIRD_API_TOKEN and optional NETBIRD_HOST environment variables.

Configure the client

Add the path and token of the Netbird MCP Server to the client configuration file.

Usage examples

List all Netbird peersAsk the Netbird MCP Server to list all peers.

Explain my Netbird network configurationAsk the Netbird MCP Server to explain the current network configuration.

Frequently Asked Questions

How to obtain a Netbird API token?

Does the Netbird MCP Server support write operations?

How to stop the Netbird MCP Server?

Related resources

Netbird official documentation

Netbird official documentation to learn more about Netbird's features and API.

Model Context Protocol (MCP) official website

The official website of the MCP protocol to learn more about the basics of MCP.

Netbird MCP Server GitHub repository

The open-source code repository for the Netbird MCP Server.

🚀 Netbird Avian Aircraft Network Server

Netbird is a network server designed for avian aircraft, offering data collection, status monitoring, and log management capabilities.

🚀 Quick Start

📦 Installation

Direct Installation

go install github.com/yourusername/mcp-netbird/cmd/mcp-netbird/main.go

Build from Source

Clone the repository:

git clone https://github.com/yourusername/mcp-netbird.git
cd mcp-netbird

Install dependencies:
```
go mod tidy
```
Build and run:
```
go run cmd/mcp-netbird/main.go
```

⚙️ Configuration

Add the following content to the configuration file:

[Netbird]
  API_TOKEN = your_api_token_here

✨ Features

Implemented Tools

Avian Aircraft Data Collection
- list_peers
- list_groups
- list_policies
Avian Aircraft Status Monitoring
- getpeer_info
- group_status
- policy_rules
Avian Aircraft Log Management
- view_logs
- clear_logs

Planned Features

Avian Aircraft Performance Optimization
- Accelerate data transmission
- Improve connection stability
Expansion Function Development
- Integrate third - party services
- Expand log analysis capabilities

💻 Usage Examples

Basic Usage

# Set the API token and run the server
export NETBIRD_API_TOKEN=your_token && \
mcp-netbird serve --listen :8001

SSE Mode

Build an image for SSE mode:

docker build -t mcp-netbird-sse:v1 -f Dockerfile.sse .

Run the image:

docker run --name mcp-netbird -p 8001:8001 -e NETBIRD_API_TOKEN=<your-api-token> mcp-netbird-sse:v1

Tool Usage Examples

View the aircraft cluster:

mcp-netbird list_peers

Get information about a specific aircraft:

mcp-netbird getpeer_info --id peer_id_here

🛠️ Development

Contribution Guidelines

Contributions are welcome! Please submit issues or pull requests via GitHub.

Dependency Management

The project is based on the following dependencies:

Grafana Labs (https://grafana.com/)
Mark III Labs (https://github.com/mark3labs/mcp-go)

🧪 Testing

make test

📦 Packaging and Distribution

make dist

📄 License

The project is licensed under the Apache License, Version 2.0.

⚠️ Important Note

Environment Variable Configuration: Ensure that NETBIRD_API_TOKEN is correctly set before running.

Log Management: It is recommended to regularly check and clear aircraft logs to maintain system performance.

Security: Use HTTPS for additional security.

If you have any questions, please contact the maintenance team at any time.