Workflows and prompting¶

This page describes the interactive session: the welcome screen, slash commands, and the three main workflows (Design, Code, Deploy), plus prompting tips.

Start Agent Assist¶

To begin, run dr assist. When DataRobot Agent Assist is started, the welcome screen shows the welcome message, three options, and the help footer:

$ dr assist
🔌 Running plugin: assist
█████████
         █████             ███████                              ████████              ██
█████████                  ██    ███             ██             ██      ██            ██                    ██
              █████        ██      ██    █████  █████   █████   ██      ██   █████    ███████      █████   █████
██████████████             ██      ███       ██  ██         ██  █████████  ██     ██  ██     ██  ██     ██  ██
              █████        ██      ██   ███████  ██    ███████  ██   ██    ██     ██  ██     ██  ██     ██  ██
█████████                  ██    ████  ██    ██  ██   ██    ██  ██    ███  ██     ██  ██     ██  ██     ██  ██
         █████             ████████    ████████  ████ ████████  ██     ███   █████    ████████     █████    ████
█████████

Welcome! I help you design, code, and deploy AI agents.

What would you like to do?
  1. Design an AI agent     → Describe your idea
  2. Code an AI agent       → Load and implement an existing agent_spec.md
  3. Deploy an AI agent     → Deploy an implemented agent to DataRobot

Type /help for commands | /quit to exit 

Input is collected at the $ prompt. Type a number (1, 2, or 3) to choose a category, or, describe the goal in natural language. If the first instruction is one of those numbers, the assistant treats it as referring to the predefined categories.

Design an AI agent¶

Use this workflow when starting a new agent idea. The assistant asks clarifying questions about the agent’s purpose, capabilities, and requirements; suggests tools and models; and produces an agent specification. The specification is displayed and written to agent_spec.md in the current directory (YAML format). The specification can be refined over several iterations. The assistant is instructed to limit clarifying questions to about two rounds before proposing an initial draft, then iterate on that draft.

Example conversation:

$ I want to create a customer support agent for an e-commerce site
Agent Assist: I'll help you design that! I can ask some questions to understand your requirements better. What specific customer issues should this agent handle?
User: $ It should handle order status, returns, and product questions
DataRobot Agent Assist: Great! What data sources will it need access to?
User: $ Our order database and product catalog
DataRobot Agent Assist: Perfect. Should it escalate complex issues to humans?
User: $ Yes, escalate billing and refund requests
DataRobot Agent Assist: I'll create a specification for your customer support agent...
[Creates and displays agent_spec.md, saves to file] 

Code an AI agent¶

Use this workflow when the agent_spec.md file already exists and is ready to implement. The assistant loads the specification and—if the template repository is not yet present—uses the prepare_to_code tool to clone the DataRobot agent template repository. It then follows the template’s AGENTS.md for setup and implementation. The assistant can run shell commands (with approval), edit files, and manage multi-step work with tools. It suggests testing locally and deploying when the implementation is ready.

Example conversation (adding a tool to an existing spec):

User: $ Load my existing agent specification and add a tool for inventory checking
Agent Assist: I found your agent_spec.md. I can see it's a customer support agent.
Let me add an inventory checking tool...
[Reads current spec and adds the requested tool] 

Deploy an AI agent¶

Use this workflow when an implemented agent is ready to deploy to DataRobot. The assistant reads the deployment instructions from the template’s AGENTS.md and guides users through the steps. It does not run deployment commands; it indicates what to run (in a separate terminal). For interactive or long-running steps (such as dr start), the assistant uses the appropriate tools as defined in the codebase.

Example conversation:

User: $ Help me deploy the agent I implemented
Agent Assist: I'll read the deployment section of AGENTS.md and walk you through the steps...
[Displays deployment commands and instructions] 

Interact with the DataRobot CLI¶

DataRobot Agent Assist runs certain DataRobot CLI (dr) commands on your behalf and can run other shell commands (including additional dr commands) with your approval.

• At startup: The assistant runs dr dependencies check to verify that required tools (Python, Node, Git, Task, Pulumi, etc.) are installed and meet minimum versions. See Prerequisites and installation.
• Code workflow: When you use the assistant to clone and prepare the template (for example, "Code an AI agent" or "prepare to code"), it runs dr start in the template directory to initialize the DataRobot project. You are prompted to approve before the command runs.
• Any workflow: The assistant can run shell commands—including dr subcommands—after you approve. It shows the command and description, then prompts for approval before executing.

For full DataRobot CLI usage (authorization, deployment, and other commands), see the DataRobot CLI documentation.

Prompting considerations¶

Consider the following guidelines to get better results from the assistant:

• Be specific: "Create a customer support agent that handles order inquiries and escalates billing issues" rather than "Create an agent".
• Provide context: "I'm building a travel booking agent and need help with the flight search API integration" rather than "Help me with my code".
• Ask for explanations: "Explain why this code isn't working and show me how to fix it" rather than "Fix this".
• Iterate: "This is good, but can you make it handle edge cases like cancelled orders?" rather than accepting the first solution.