
netboxlabs/netbox-mcp-server
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
netboxlabs/netbox-mcp-server — это кандидат на MCP-сервер, импортированный из https://github.com/netboxlabs/netbox-mcp-server.
Обзор
netboxlabs/netbox-mcp-server — это кандидат на MCP-сервер, импортированный из https://github.com/netboxlabs/netbox-mcp-server.
Обзор (машинный перевод)
** ⚠️ Breaking Change в v1.0.0**: Структура проекта изменилась. Если вы обновляетесь с версии 0.1.0, обновите конфигурацию:
- Изменить
uv run server.pyнаuv run netbox-mcp-server- Обновить конфигурации рабочего стола/кода Claude для использования
netbox-mcp-serverвместоserver.py- Пользователи Docker: перестраивают образы с обновлённым CMD
- См. CHANGELOG.md для подробностей
Это простой сервер Model Context Protocol для NetBox, предназначенный только для чтения. Он позволяет напрямую взаимодействовать с вашими данными в NetBox через LLM, поддерживающие MCP.
Сервер специально простой: прост в начале, трудно использовать неправильно (по умолчанию только для чтения, без поверхности плагина), и прост для форка и адаптации. Форк под Apache 2.0 — первоклассный путь для пользователей, которым нужны возможности вне рамок проекта.
Сообщество
Для чата, кейсов использования и общего обсуждения MCP присоединяйтесь к сообществу NetBox на netdev.chat. Канал #ai — это идеальное место для интеграций MCP, вопросов и совместного использования кейсов использования. Проблемы с багами и идеями для этого сервера.
Инструменты
| Инструмент | Описание |
|---|---|
| get_objects | Извлекает основные объекты NetBox на основе их типа и фильтров |
Эта страница переведена автоматически. Технические детали смотрите в оригинале.
README
Показан фрагмент оригинального README. Открыть оригинал.
NetBox MCP Server
⚠️ Breaking Change in v1.0.0: The project structure has changed. If upgrading from v0.1.0, update your configuration:
- Change
uv run server.pytouv run netbox-mcp-server- Update Claude Desktop/Code configs to use
netbox-mcp-serverinstead ofserver.py- Docker users: rebuild images with updated CMD
- See CHANGELOG.md for full details
This is a simple read-only Model Context Protocol server for NetBox. It enables you to interact with your data in NetBox directly via LLMs that support MCP.
The server is intentionally simple: easy to get started with, hard to misuse (read-only by default, no plugin surface), and easy to fork and adapt. Forking under Apache 2.0 is a first-class path for users who need capabilities beyond the project’s scope.
Community
For chat, use cases, and general MCP discussion, join the NetBox community at netdev.chat. The #ai channel is the right home for MCP integrations, questions, and sharing use cases. Bugs and feature ideas specific to this server go in issues.
Tools
| Tool | Description |
|---|---|
| get_objects | Retrieves NetBox core objects based on their type and filters |
| get_object_by_id | Gets detailed information about a specific NetBox object by its ID |
| get_changelogs | Retrieves change history records (audit trail) based on filters |
Note: Core NetBox object types are always available. Plugin object types can be auto-discovered. See Plugin Object Type Discovery. Advanced features (GraphQL, dynamic model discovery, etc.) are deliberately out of scope. See CONTRIBUTING.md for the full scope statement and rationale.
Usage
-
Create a read-only API token in NetBox with sufficient permissions for the tool to access the data you want to make available via MCP.
-
Install dependencies:
# Using UV (recommended) uv sync # Or using pip pip install -e . -
Verify the server can run:
NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN= uv run netbox-mcp-server -
Add the MCP server to your LLM client. See below for some examples with Claude.
Claude Code
Stdio Transport (Default)
Add the server using the claude mcp add command:
claude mcp add --transport stdio netbox \
--env NETBOX_URL=https://netbox.example.com/ \
--env NETBOX_TOKEN= \
-- uv --directory /path/to/netbox-mcp-server run netbox-mcp-server
Important notes:
- Replace
/path/to/netbox-mcp-serverwith the absolute path to your local clone - The
--separator distinguishes Claude Code flags from the server command - Use
--scope projectto share the configuration via.mcp.jsonin version control
Установка
docker run --rm \Конфигурация
{
"mcpServers": {
"netbox": {
"command": "uv",
"args": [
"--directory",
"/path/to/netbox-mcp-server",
"run",
"netbox-mcp-server"
],
"env": {
"NETBOX_URL": "https://netbox.example.com/",
"NETBOX_TOKEN": "<your-api-token>"
}
}
}
}