Metadata-Version: 2.3
Name: nautobot-agent
Version: 1.0.0
Summary: AI agent integration for Nautobot.
License: MIT
Keywords: nautobot,nautobot-app,nautobot-plugin
Author: Geury Torres
Author-email: geuryt@yahoo.com
Requires-Python: >=3.12,<3.15
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: dev
Requires-Dist: coverage ; extra == "dev"
Requires-Dist: deepagents (==0.7.34)
Requires-Dist: djlint (>=1.36.4,<2.0.0) ; extra == "dev"
Requires-Dist: fastmcp (>=4.1,<5)
Requires-Dist: invoke ; extra == "dev"
Requires-Dist: langchain (>=1.4.9,<2)
Requires-Dist: langchain-anthropic (==1.7.10)
Requires-Dist: langchain-core (>=1.7.6,<2)
Requires-Dist: langchain-deepseek (==1.1.1)
Requires-Dist: langchain-google-genai (==4.4.3)
Requires-Dist: langchain-ollama (==1.1.0)
Requires-Dist: langchain-openai (==1.7.4)
Requires-Dist: langchain-openrouter (==0.2.9)
Requires-Dist: langgraph (==1.2.12)
Requires-Dist: langgraph-checkpoint (==4.2.0)
Requires-Dist: langgraph-checkpoint-conformance (==0.0.2) ; extra == "dev"
Requires-Dist: markdown-it-py (>=4.2.0,<5)
Requires-Dist: mcp (>=2.3,<3)
Requires-Dist: nautobot (>=3.0.0,<4.0.0)
Requires-Dist: pydantic-monty (==1.5.0)
Requires-Dist: pylint ; extra == "dev"
Requires-Dist: pylint-django (>=2.5.4) ; extra == "dev"
Requires-Dist: pylint-nautobot (>=0.3.1) ; extra == "dev"
Requires-Dist: pymarkdownlnt (>=0.9.30,<0.10.0) ; extra == "dev"
Requires-Dist: ruff (==0.17.3) ; extra == "dev"
Requires-Dist: ty (==0.0.94) ; extra == "dev"
Project-URL: Homepage, https://github.com/gt732/nautobot-app-nautobot-agent
Project-URL: Repository, https://github.com/gt732/nautobot-app-nautobot-agent
Description-Content-Type: text/markdown

# Nautobot Agent

![Nautobot Agent banner](docs/media/repo-banner.png)

Nautobot Agent is a general-purpose conversational agent integrated into Nautobot. Use it to ask questions, explore ideas, and get explanations or code examples in chat; connect conversations to Nautobot inventory and installed-App knowledge through permission-aware built-in tools.

**Privacy and trust:** Messages, relevant Nautobot data, and authorized source text are sent to the configured model provider. Tracing is enabled by default and may contain unredacted prompts and tool data. Built-in tools are permission-aware and read-only; optional MCP servers are a separate trust boundary and may have broader access or external effects. Review [Privacy and data handling](docs/user/privacy.md) before use.

## See it in action

https://github.com/user-attachments/assets/afd90d23-c75d-4ae5-864c-6440a23b61da

## How it works

![Nautobot Agent chat lifecycle: from question to answer](docs/media/nautobot-agent-from-question-to-answer.gif)

## What you can do

- Get help with general questions, explanations, and code examples in chat; use permission-aware, read-only built-in tools for Nautobot inventory and authorized installed-App source.
- Use native integrations for OpenAI, Anthropic, Google Gemini Developer API, Ollama, OpenRouter, and DeepSeek.
- Explore results with charts and Mermaid diagrams, and save conversations.
- Extend the assistant with optional custom skills and MCP integrations.
- Inspect execution traces with bounded previews and authorized full JSON view or download.

The default scope policy admits Nautobot-related requests. Administrators can change it to allow broader, general-purpose requests; this does not broaden built-in Nautobot data permissions. See [Scope policy](docs/admin/configuration.md#scope-policy).

Built-in tools cannot create or modify files. File operations are possible only if an administrator enables MCP tools that provide them; those tools are a separate trust boundary.

### Screenshots

Chat with Nautobot Agent:
![Nautobot Agent screenshot](docs/media/nautobot-agent-screenshot.png)

Chart rendering:
![Nautobot Agent Chart screenshot](docs/media/nautobot-agent-chart-screenshot.png)

Mermaid diagram rendering:
![Nautobot Agent Mermaid screenshot](docs/media/nautobot-agent-mermaid-screenshot.png)

MCP Integration with Nautobot Agent:
![Nautobot Agent MCP screenshot](docs/media/nautobot-agent-mcp-screenshot.png)

Agent Observability and tracing with Nautobot Agent:
![Nautobot Agent Trace screenshot](docs/media/nautobot-agent-trace-screenshot.png)

## Documentation

- [Overview](docs/user/app_overview.md)
- [Getting started](docs/user/getting_started.md)
- [Installation](docs/admin/install.md)
- [Configuration](docs/admin/configuration.md)
- [Integrations](docs/admin/integrations.md)
- [Operations](docs/admin/operations.md)
- [Compatibility](docs/admin/compatibility.md)
- [FAQ](docs/user/faq.md)

For how this documentation is maintained, see [Building documentation](docs/dev/documentation.md).

## Contributing

With Docker and Docker Compose installed, copy
`development/nautobot_config.example.py` to `development/nautobot_config.py`
once, then run `docker compose up` from the repository root. The local
configuration is ignored by Git and can be edited freely.
Open <http://localhost:8080> and sign in with `admin` / `admin`.
The stack installs the app and its pinned Nautobot development version.
See [Docker development](docs/dev/docker.md) for requirements, checks, and
local-only security restrictions.

## License

MIT

