OpenParable
Skip to content
← Back to skills

Form Building

Development
form-building

Form Building is an Agent Skill for development published in the BuilderIO/agent-native repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

How to create and structure forms. Use when creating a new form, adding fields, modifying form structure, or understanding field types and their JSON schema.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/BuilderIO/agent-native/blob/HEAD/templates/forms/.agents/skills/form-building/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/form-building, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Form Building

Creating a Form

Use the create-form script to create forms from natural language:

pnpm action create-form --title "Contact Form" --fields '[...]'

The script generates a unique ID, creates a URL slug, and stores the form in SQL as draft status.

Field Types

TypeDescriptionOptions neededExample use
textSingle-line text inputNoName, company
emailEmail input with validationNoContact email
numberNumeric inputNoAge, quantity
textareaMulti-line textNoMessage, comments
selectSingle-choice dropdownYesCountry, department
multiselectMulti-choice dropdownYesSkills, interests
checkboxBoolean toggleNoConsent, opt-in
radioSingle-choice radio buttonsYesGender, preference
dateDate pickerNoBirthday, deadline
ratingStar rating (1-5)NoSatisfaction, quality
scaleNumeric scale (e.g., 1-10)NoNPS, likelihood

Field JSON Schema

Each field is a JSON object:

{
  "id": "field_name",
  "type": "text",
  "label": "Your Name",
  "placeholder": "Enter your name",
  "description": "Help text shown below the field",
  "required": true,
  "options": ["Option A", "Option B"],
  "validation": {
    "min": 1,
    "max": 100,
    "pattern": "^[a-zA-Z]+$",
    "message": "Custom error message"
  },
  "conditional": {
    "fieldId": "other_field_id",
    "operator": "equals",
    "value": "show_this_field"
  },
  "width": "full"
}

Required properties

  • id — unique identifier (snake_case recommended)
  • type — one of the types above
  • label — display label
  • required — boolean

Optional properties

  • placeholder — input placeholder text
  • description — help text below the field
  • options — array of strings (required for select, multiselect, radio)
  • validation — min/max/pattern/message for custom validation
  • conditional — show field only when another field matches a condition
  • width — "full" (default) or "half" for side-by-side layout

Updating a Form

Use update-form to modify any form property:

# Change title
pnpm action update-form --id <id> --title "New Title"

# Update fields
pnpm action update-form --id <id> --fields '[...]'

# Change status
pnpm action update-form --id <id> --status published

Common Form Templates

When a user asks for a common form type, use these field patterns:

Contact form:

[
  {"id":"name","type":"text","label":"Name","required":true},
  {"id":"email","type":"email","label":"Email","required":true},
  {"id":"message","type":"textarea","label":"Message","required":true}
]

Survey/feedback:

[
  {"id":"rating","type":"rating","label":"Overall satisfaction","required":true},
  {"id":"recommend","type":"scale","label":"How likely to recommend? (1-10)","required":true},
  {"id":"feedback","type":"textarea","label":"Additional feedback","required":false}
]

Registration/signup:

[
  {"id":"first_name","type":"text","label":"First Name","required":true,"width":"half"},
  {"id":"last_name","type":"text","label":"Last Name","required":true,"width":"half"},
  {"id":"email","type":"email","label":"Email","required":true},
  {"id":"role","type":"select","label":"Role","options":["Student","Professional","Other"],"required":true}
]

Workflow

  1. create-form with title and fields
  2. Preview in the GUI (agent + user iterate)
  3. update-form --status published to go live
  4. Share the public URL: /f/<slug>

Related Skills

  • form-responses — Viewing and analyzing submitted data
  • form-publishing — Form lifecycle (draft -> published -> closed)
  • scripts — All form operations go through scripts