The Build Agent is the IDE's AI assistant for building Unqork modules. You describe what you want in plain language, and the agent creates a plan for your review. Once approved, the agent builds the components, generates tests, and shows you the result.
This guide walks you through your first interaction with the Build Agent.
Before You Begin
The Build Agent is available to Creators with access to the Module Builder. If you do not see the Agent Chat tab in your IDE, contact your environment administrator.
Step 1: Open the Build Agent
- Open any module in the Module Builder.
- Locate the Agent Chat tab in the left panel.
- Click the tab to open the agent.
Step 2: Send Your First Prompt
A clear, specific prompt produces the best results. Try the following:
Create a contact form with fields for first name, last name, and email address. Set all fields as required. Add a Submit button that collects the form data.
The agent analyzes your request and creates a plan before building anything. The plan opens in the canvas area and includes the following:
- Analysis: A summary of the current module state and what the agent intends to build.
- Detailed Component Specifications: The components the agent plans to create, including types, Property IDs, and validation rules.
- Tests: Test cases the agent will run to verify the form works correctly.
- Execution Plan: The steps the agent will follow to build the module.
Step 3: Approve the Plan
After generating the plan, the agent asks for your approval before proceeding.
Review the plan in the canvas area, then click Build or type approved in the chat to begin. If anything looks incorrect, describe the changes you want in the chat before building.
Step 4: Review the Results
Once the agent finishes building, it runs the test cases from the plan automatically and displays a Test Execution Report in the left panel. Review the pass/fail results and the build summary, which lists every component configured and task completed.
If anything looks incorrect, refine your prompt and try again.
Important: The agent automatically saves each change as a minor version. Save the module manually to publish changes to the production application.
Step 5: Save and Preview
- Save the module to preserve your changes.
- Preview the module to confirm it behaves as expected. Two options are available:
- Preview Mode toggle: Displays the preview inline in the canvas area.
- Preview button: Opens the module in a new tab.
Step 6: Continue Building
Once the agent finishes, you have the following options:
- Continue Building: Send another prompt in the Agent Chat panel.
- Start a New Plan: Click + at the top of the Agent Chat panel.
- Undo Changes: Click Rollback at any checkpoint in the Agent Chat panel to revert the agent's most recent changes.
When you're ready to go further, the Build Agent can also generate test data and simulate API calls. It can also suggest accessibility improvements and implement data processing logic through natural language prompts.
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |