Files
docker-images/images/netbox-mcp-server/README.md

71 lines
1.8 KiB
Markdown

# 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 ?
```