Netbird MCP Server Integration

What does “Netbird” MCP Server do?

The Netbird MCP Server is a Model Context Protocol (MCP) server designed to connect AI assistants with the Netbird network management platform. By interfacing with the Netbird API, this MCP server enables AI models and agents to access network configuration, status, and related information directly from Netbird. This integration enhances development workflows by allowing tasks such as querying network resources, retrieving configuration details, and monitoring network status, all through a standardized protocol. The server is built with security in mind, leveraging token-based authentication, and is configurable to point to custom Netbird API endpoints. Note that the current implementation is a 1:1 mapping of select read-only Netbird API resources to tools, primarily supporting information retrieval.

List of Prompts

List of Resources

List of Tools

The Netbird MCP Server exposes MCP tools that map to select read-only Netbird API resources. However, specific tool names and their descriptions are not detailed in the available documentation or code overview.

Use Cases of this MCP Server

• Network Configuration Monitoring: Developers can leverage the MCP server to retrieve up-to-date Netbird network configurations and visualize or audit current network settings.
• Network Status Inspection: The server can provide real-time status information from the Netbird API, enabling proactive network health checks.
• Secure API Integration: By using token-based authentication, the MCP server allows secure, programmatic access to Netbird data for automation tasks.
• Customizable API Endpoint Access: Developers can point the server to different Netbird API hosts, supporting testing or staging environments.

How to set it up

Windsurf

1. Ensure you have Node.js and the Windsurf app installed.
2. Locate the Windsurf configuration file (typically windsurf.json).
3. Add the Netbird MCP Server to the mcpServers section:

   {
     "mcpServers": {
       "netbird": {
         "command": "npx",
         "args": ["@aantti/mcp-netbird@latest"]
       }
     }
   }
   

4. Save the configuration and restart Windsurf.
5. Verify setup by checking the Windsurf logs for successful server connection.

Claude

1. Install Node.js and the Claude desktop client.
2. Open the configuration file (e.g., claude.json).
3. Add the Netbird MCP Server configuration:

   {
     "mcpServers": {
       "netbird": {
         "command": "npx",
         "args": ["@aantti/mcp-netbird@latest"]
       }
     }
   }
   

4. Restart Claude.
5. Confirm the Netbird MCP Server is active in the MCP panel.

Cursor

1. Make sure Node.js and Cursor are installed.
2. Edit the Cursor configuration (e.g., .cursor.json).
3. Insert the following MCP server setup:

   {
     "mcpServers": {
       "netbird": {
         "command": "npx",
         "args": ["@aantti/mcp-netbird@latest"]
       }
     }
   }
   

4. Save changes and restart Cursor.
5. Check server connectivity in the Cursor interface.

Cline

1. Install Node.js and Cline.
2. Find and open the configuration file (e.g., cline.json).
3. Add the Netbird MCP Server entry:

   {
     "mcpServers": {
       "netbird": {
         "command": "npx",
         "args": ["@aantti/mcp-netbird@latest"]
       }
     }
   }
   

4. Save and restart Cline.
5. Ensure the Netbird MCP Server is listed as active.

Securing API Keys

Store your Netbird API key in an environment variable for security:

{
  "mcpServers": {
    "netbird": {
      "command": "npx",
      "args": ["@aantti/mcp-netbird@latest"],
      "env": {
        "NETBIRD_API_TOKEN": "your_secret_token"
      },
      "inputs": {
        "NETBIRD_HOST": "api.netbird.io"
      }
    }
  }
}

How to use this MCP inside flows

Using MCP in FlowHunt

To integrate MCP servers into your FlowHunt workflow, start by adding the MCP component to your flow and connecting it to your AI agent:

Click on the MCP component to open the configuration panel. In the system MCP configuration section, insert your MCP server details using this JSON format:

{
  "netbird": {
    "transport": "streamable_http",
    "url": "https://yourmcpserver.example/pathtothemcp/url"
  }
}

Once configured, the AI agent is now able to use this MCP as a tool with access to all its functions and capabilities. Remember to change “netbird” to whatever the actual name of your MCP server is and replace the URL with your own MCP server URL.

Overview

Based on the above table, the Netbird MCP Server primarily covers core setup and access mechanisms, but lacks detailed documentation on prompts, resources, and sampling support. It is functional for basic Netbird API integration but would benefit from more comprehensive MCP-specific documentation.

Our opinion

This MCP server scores moderately. While it provides essential Netbird API integration and secure setup instructions, it lacks documentation on prompts, resources, and advanced MCP features like sampling and roots. The presence of a LICENSE and basic tool mapping is a plus, but the absence of detailed tool/resource lists and use-case depth limits its utility for more advanced AI/dev workflows.

MCP Score