NetBox MCP Server

Welcome to the NetBox MCP Server documentation! This server implements the Model Context Protocol (MCP) for NetBox, enabling AI language models to interact directly with your NetBox data.

Quick Navigation

• Installation Guide
• Configuration
• Usage Examples
• API Reference
• Cursor AI Integration
• Development Guide
• Troubleshooting

Overview

The NetBox MCP Server provides a bridge between Large Language Models (LLMs) and your NetBox instance, allowing natural language interactions with your network infrastructure data. It supports:

• Full read/write access to all core NetBox objects
• Global search functionality
• Detailed object retrieval
• Comprehensive filtering capabilities
• Create, update, and delete operations

Key Features

1. MCP Integration

   • Seamless integration with MCP-compatible LLMs
   • Natural language queries for NetBox data
   • Structured data responses

2. NetBox Object Support

   • DCIM (Device and Infrastructure)
   • IPAM (IP Address Management)
   • Circuits
   • Virtualization
   • Tenancy
   • VPN
   • Wireless

3. Security

   • Configurable read-only or read-write API access
   • Token-based authentication
   • SSL verification support

Getting Started

1. Install the server
2. Configure your environment
3. Try the example queries

Contributing

Contributions are welcome! Please see our Development Guide for details on how to contribute to the project.

License

This project is licensed under the Apache 2.0 license. See the LICENSE file for details.