lmiranda
d9d80d77cb
Reduces NetBox MCP context token consumption from ~19,810 tokens (182 tools) to ~4,500 tokens (~43 tools) by enabling environment-variable-driven module filtering. Key changes: - Add NETBOX_ENABLED_MODULES env var to config.py - Filter tool registration based on enabled modules in server.py - Conditional tool class instantiation for memory efficiency - Routing guard with clear error messages for disabled modules - Startup logging shows enabled modules and tool count Also fixes documentation referencing incorrect tool names: - virtualization_* → virt_* in cmdb-assistant docs - wireless_* → wlan_* in README - circuits_list_circuit_terminations → circ_list_terminations Recommended config for cmdb-assistant users: NETBOX_ENABLED_MODULES=dcim,ipam,virtualization,extras Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
59 lines
2.7 KiB
Markdown
59 lines
2.7 KiB
Markdown
## Infrastructure Management (cmdb-assistant)
|
|
|
|
This project uses the **cmdb-assistant** plugin for NetBox CMDB integration to manage network infrastructure.
|
|
|
|
### Available Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `/cmdb-search` | Search across all NetBox objects |
|
|
| `/cmdb-device` | Manage devices (create, update, list) |
|
|
| `/cmdb-ip` | Manage IP addresses and prefixes |
|
|
| `/cmdb-site` | Manage sites and locations |
|
|
|
|
### MCP Tools Available
|
|
|
|
The following NetBox MCP tools are available for infrastructure management:
|
|
|
|
**DCIM (Data Center Infrastructure Management):**
|
|
- `dcim_list_devices`, `dcim_get_device`, `dcim_create_device`, `dcim_update_device` - Device management
|
|
- `dcim_list_sites`, `dcim_get_site`, `dcim_create_site` - Site management
|
|
- `dcim_list_racks`, `dcim_get_rack`, `dcim_create_rack` - Rack management
|
|
- `dcim_list_interfaces`, `dcim_create_interface` - Interface management
|
|
- `dcim_list_cables`, `dcim_create_cable` - Cable management
|
|
- `dcim_list_device_types`, `dcim_list_device_roles`, `dcim_list_manufacturers` - Reference data
|
|
- `dcim_list_regions`, `dcim_list_locations` - Location hierarchy
|
|
|
|
**IPAM (IP Address Management):**
|
|
- `ipam_list_ip_addresses`, `ipam_create_ip_address`, `ipam_get_ip_address` - IP address management
|
|
- `ipam_list_prefixes`, `ipam_create_prefix`, `ipam_list_available_prefixes` - Prefix management
|
|
- `ipam_list_vlans`, `ipam_create_vlan` - VLAN management
|
|
- `ipam_list_vrfs`, `ipam_create_vrf` - VRF management
|
|
- `ipam_list_available_ips`, `ipam_create_available_ip` - IP allocation
|
|
|
|
**Virtualization:**
|
|
- `virt_list_vms`, `virt_create_vm`, `virt_update_vm`, `virt_delete_vm` - VM management
|
|
- `virt_list_clusters`, `virt_create_cluster`, `virt_update_cluster`, `virt_delete_cluster` - Cluster management
|
|
- `virt_list_vm_ifaces`, `virt_create_vm_iface` - VM interface management
|
|
|
|
**Circuits:**
|
|
- `circuits_list_circuits`, `circuits_create_circuit` - Circuit management
|
|
- `circuits_list_providers`, `circuits_create_provider` - Provider management
|
|
|
|
**Tenancy:**
|
|
- `tenancy_list_tenants`, `tenancy_create_tenant` - Tenant management
|
|
- `tenancy_list_contacts`, `tenancy_create_contact` - Contact management
|
|
|
|
**Extras:**
|
|
- `extras_list_tags`, `extras_create_tag` - Tag management
|
|
- `extras_list_journal_entries`, `extras_create_journal_entry` - Audit journal
|
|
- `extras_list_object_changes` - Change tracking
|
|
|
|
### Usage Guidelines
|
|
|
|
- Use NetBox MCP tools for all infrastructure queries and modifications
|
|
- Always verify device/IP existence before creating duplicates
|
|
- Use tags for categorization and filtering
|
|
- Create journal entries for significant changes to maintain audit trail
|
|
- Check available IPs in a prefix before manual allocation
|