NautobotGPT MCP Server¶
A Model Context Protocol (MCP) server for NautobotGPT.
Overview¶
The NautobotGPT MCP Server enables integration between NautobotGPT and AI coding assistants such as Claude Code and GitHub Copilot in VS Code. Using the Model Context Protocol (MCP), it acts as a bridge that allows you to leverage NautobotGPT's specialized Nautobot knowledge directly within your development environment.
This means you can ask Nautobot-related questions, get help writing Jobs, and receive expert guidance — all without leaving your IDE or coding assistant.
flowchart LR
A["AI Coding Assistants
(Claude Code, GitHub Copilot, OpenAI Codex, etc.)"]
B["NautobotGPT
MCP Server"]
C["NautobotGPT"]
A --> B
B --> C
How It Works¶
The MCP Server runs as a sidecar service alongside your NautobotGPT instance in Nautobot Cloud — there is nothing to install or host on your end. It exposes an MCP-compatible endpoint that your AI coding assistant connects to, routing your Nautobot-related queries through NautobotGPT's specialized agents for authoritative answers.
Each user authenticates with their own NautobotGPT API key. All queries are processed through NautobotGPT's multi-agent architecture, giving you the same quality of responses you get in the NautobotGPT web interface.
What You Can Do¶
With the NautobotGPT MCP Server connected to your AI coding assistant, you can:
- Get Nautobot coding guidance in your IDE — Ask how to write Jobs, FilterSets, custom validators, and more
- Troubleshoot errors — Paste tracebacks or error messages and get Nautobot-specific solutions
- Learn best practices — Ask about Nautobot job structure, data models, and design patterns
- Generate code — Request code snippets and examples tailored to Nautobot's conventions
Example Prompts¶
"How do I create a custom validator in Nautobot?"
"Write a FilterSet for the Device model with filters for status, location, and role"
"What are the best practices for structuring a Nautobot Job?"
"How do I debug a failing Nautobot Job that times out during execution?"
Next Steps¶
Ready to get started? Head to the Getting Started guide to generate your API key and connect your AI coding assistant.