> For the complete documentation index, see [llms.txt](https://docs.vex-nx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vex-nx.com/assist/using-assist.md). # Using Assist ![Assist dock](https://1807546539-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhgHCHWL3861o2DBW53aA%2Fuploads%2FY03RATkO0kb7Ooj3xjUq%2Fve20261112v5-assist-dock.png?alt=media) ## Goal Use the Assist dock to create labs, draft configs, and drive MCP lab tools (commercial editions with LLM configured). ## Why Assist exists Assist is a lab-aware planner: you describe what you need in natural language (or use chips), it proposes steps, and it can call allowlisted lab tools (create lab, add nodes/links, generate/apply configs, start, capture, export). It is not a local demo script that hardcodes OSPF/MPLS recipes. ## Before you start * Edition with Assist enabled ([Features](/getting-started/features.md)) * Admin has configured OpenRouter: Assist LLM settings * Student has **no** Assist agent - chips stay disabled unless licensed; Assist always uses LLM (no local stub path) ## Toolbar On the lab page (Design / Operate / Observe): click **Assist**. Maximize, collapse to rail, or resize. Full chrome map: Toolbars and More menu. ## What Assist can help with | Capability | Notes | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | Natural-language lab creation | Describe topology goals; planner may create labs / nodes / links | | Configuration generation | Draft startup configs for nodes; review diffs before apply | | Validate explanations | Explain Validate findings | | Capture / export shortcuts | Packet capture and config pack export (when licensed) | | Migrate / running-config flows | See Recreate labs from production configs | | Live device CLI (supported platforms) | Small explicit prompts; Cisco IOS-like, NX-OS, ASA, EOS, FRR `vtysh`, Junos, Fortinet, PAN-OS, VyOS, MikroTik, and others | ## Assist chips (quick actions) | Chip | What it asks Assist to do | | ------------ | --------------------------------------------------------- | | **Build** | Help build a lab from your description | | **Configs** | Generate and apply startup configs from your goals | | **Fix** | Review configs / guide and fix problems | | **Publish** | Publish a fixed starter as catalog default (asks confirm) | | **Capture** | Capture packets on a lab link | | **Export** | Export the config pack | | **Validate** | Open / explain Validate findings | ## Recipe: ask from a lab 1. Open a lab 2. Open **Assist** 3. Pick a chip or type a clear request (vendors, protocol, scale) 4. Review plan steps, diffs, and confirm prompts before accepting destructive actions (Start, wipe-like ops, publish) 5. Copy results into Terminal / ScriptPad when you want manual control Example prompts (synthetic): * `Create a 3-router lab using Cisco IOSv with a triangle of links for OSPF Area 0.` * `Generate startup configs for all routers with hostname R1/R2/R3 and OSPF on GigabitEthernet0/0.` * `Explain why Validate is failing for this lab.` ## Safety * Tool names are allowlisted on the server; unknown tools are rejected * Lab access control applies to every tool call * Destructive steps can require UI confirmation * Do not paste real production secrets into Assist; use synthetic labs for demos ## Expected result * Replies and plan steps appear in the dock * You can copy commands into Terminal / ScriptPad * Confirm prompts appear before risky steps ## If it fails | Symptom | Fix | | ------------------------------- | ------------------------------------------------------------ | | Assist missing / chips disabled | Community or licence without Assist; or OpenRouter not ready | | Test / timeout | Check OpenRouter key, model, outbound network (LLM settings) | | Wrong node context | Select the node; ensure the open lab is current | ## Related * Recreate labs from production configs * OpenRouter LLM * MCP and AI tools * [Design mode](/labs/design-mode.md) ScriptPad profiles * Admin Assist LLM settings --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.vex-nx.com/assist/using-assist.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.