From b577369cdd245f6a43fd504cdadd4ad952aad1b4 Mon Sep 17 00:00:00 2001 From: Damien Arnodo Date: Sat, 10 Jan 2026 20:19:25 +0000 Subject: [PATCH] docs: add netbox-mcp-server README --- images/netbox-mcp-server/README.md | 70 ++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 images/netbox-mcp-server/README.md diff --git a/images/netbox-mcp-server/README.md b/images/netbox-mcp-server/README.md new file mode 100644 index 0000000..703772a --- /dev/null +++ b/images/netbox-mcp-server/README.md @@ -0,0 +1,70 @@ +# NetBox MCP Server + +Image Docker pour le [NetBox MCP Server](https://github.com/netboxlabs/netbox-mcp-server) - serveur Model Context Protocol permettant l'interaction read-only avec NetBox via LLMs. + +## Usage avec Claude Desktop (STDIO) + +Configuration dans `claude_desktop_config.json` : + +```json +{ + "mcpServers": { + "netbox": { + "command": "docker", + "args": [ + "run", "-i", "--rm", + "-e", "NETBOX_URL", + "-e", "NETBOX_TOKEN", + "gitea.arnodo.fr/damien/netbox-mcp-server:latest" + ], + "env": { + "NETBOX_URL": "https://netbox.example.com/", + "NETBOX_TOKEN": "your-api-token" + } + } + } +} +``` + +## Usage en mode HTTP + +Pour les clients web MCP : + +```bash +docker run --rm \ + -e NETBOX_URL=https://netbox.example.com/ \ + -e NETBOX_TOKEN=your-api-token \ + -e TRANSPORT=http \ + -p 8000:8000 \ + gitea.arnodo.fr/damien/netbox-mcp-server:latest +``` + +Le serveur sera accessible sur `http://localhost:8000/mcp`. + +## Variables d'environnement + +| Variable | Défaut | Description | +|----------|--------|-------------| +| `NETBOX_URL` | - | URL de l'instance NetBox (requis) | +| `NETBOX_TOKEN` | - | Token API NetBox read-only (requis) | +| `TRANSPORT` | `stdio` | Transport MCP : `stdio` ou `http` | +| `VERIFY_SSL` | `true` | Vérification des certificats SSL | +| `LOG_LEVEL` | `INFO` | Niveau de log | +| `HOST` | `0.0.0.0` | Adresse d'écoute (mode HTTP) | +| `PORT` | `8000` | Port d'écoute (mode HTTP) | + +## Outils MCP disponibles + +| Outil | Description | +|-------|-------------| +| `get_objects` | Récupère les objets NetBox selon type et filtres | +| `get_object_by_id` | Détails d'un objet par son ID | +| `get_changelogs` | Historique des modifications | + +## Exemples de requêtes + +``` +> Liste tous les devices du site 'DC1' +> Montre-moi l'utilisation IPAM +> Qui a modifié le routeur principal cette semaine ? +```