General guidelines for Build Agent

  • Release version: Zurich
  • Updated April 1, 2026
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of General guidelines for Build Agent

    These guidelines help ServiceNow customers effectively integrate Build Agent into their development workflows, maximizing productivity and ensuring high-quality application builds. The recommendations cover development best practices and prompting techniques tailored for Build Agent usage within the ServiceNow Zurich release.

    Show full answer Show less

    Development guidelines

    • Design before coding: Plan and document application requirements across data and UI layers using tools like Workflow Studio or Figma.
    • Start with a clear plan: Collaborate with Build Agent to define application scope, necessary tables, and metadata types before development.
    • Instruct with context: Provide detailed instructions using Markdown files in your project directory to guide Build Agent with relevant context.
    • Use specific ServiceNow terminology: Use platform-specific terms such as table names, field names, roles, and artifact types to improve accuracy and reduce iterations.
    • Test early and often: Add sample records, perform instance testing, and build Automated Test Framework (ATF) tests throughout development.
    • Use version control: Employ Git to track changes and maintain a clean workspace.
    • Provide visual context: Share screenshots with Build Agent to troubleshoot UI issues effectively.
    • Extend with third-party libraries: Integrate NPM libraries like React JS to enhance interfaces.
    • Maintain documentation: Keep clear rules and documentation in project folders; leverage Build Agent to create knowledge base articles.
    • Iterate and experiment: Prototype freely and later ask Build Agent to generate ideal prompts to replicate final designs.
    • Use ESLint: Define coding styles on the ServiceNow AI Platform and have Build Agent enforce these standards (e.g., snake case for variables).

    Prompting guidelines

    • Ask Build Agent to prompt for you: Request Build Agent to suggest ideal prompts or warn about common pitfalls for metadata types.
    • Be comprehensive: Provide detailed prompts that include all relevant components (tables, fields, roles, automation) for better results.
    • Use the planning tool: For complex applications, have Build Agent create a plan first and approve it before building begins.
    • Let Build Agent interview you: Allow Build Agent to ask clarifying questions to refine understanding and produce accurate outputs.
    • Use precise ServiceNow terminology: Refer to specific tables (e.g., sysuser) and artifacts to reduce clarification cycles and improve first-attempt accuracy.
    • Balance conversational and precise prompts: Use conversational prompts during early exploration and shift to precise prompts as development progresses.
    • Draft offline: Compose and refine prompts in a text editor before pasting into Build Agent’s chat to improve prompt quality.
    • Develop incrementally: Build and test each page or feature in separate chat sessions for focused development and validation.
    • Use Markdown files: Place Markdown files (e.g., GUIDE.md, BUILDAGENTRULES.md) in project directories to communicate organizational standards and conventions. This feature is currently supported only in the ServiceNow IDE.

    Use these guidelines to get the most out of Build Agent in your development workflow.

    Development guidelines

    To maximize Build Agent effectiveness, use the following practices:
    • Design before coding: Think through and document the requirements for your application across the data and UI layers, for example using Workflow Studio or Figma.
    • Start with a clear plan: Collaborate with Build Agent to define scope, required tables, and metadata types.
    • Instruct with context: Write instructions for what you want to achieve with your application using Markdown in your file system, and ask Build Agent to use the file as context for its work.
    • Use specific terminology: Treat Build Agent as your development partner. Provide specific, clear instructions using ServiceNow platform terminology such as table names, field names, roles, and artifact types.
    • Test early and often: Add sample records, test on the instance, and build ATF tests throughout development.
    • Use version control: Use Git for tracking changes and maintaining a clean workspace structure.
    • Provide visual context: Give screenshots to Build Agent to troubleshoot UI issues and request changes.
    • Extend with third-party libraries: Integrate third-party Node Package Manager (NPM) libraries, such as React JS, for enhanced interfaces.
    • Maintain documentation: Keep clear rules and documentation in project folders; use Build Agent to create knowledge base articles.
    • Iterate and experiment: Prototype freely, then ask Build Agent for an ideal prompt to recreate the result once your vision is complete.

    Prompting guidelines

    Use the following guidelines to get better results from Build Agent.

    Ask Build Agent to prompt for you
    Ask Build Agent to suggest an ideal prompt for your goal or coach you on common pitfalls for a given metadata type. To learn more, see this Community article on The fastest way to learn Build Agent prompting? Ask Build Agent.
    Be comprehensive
    One detailed prompt can provide better results than several vague ones. Include tables, fields, roles, and automation in a single prompt.
    Use the planning tool
    For complex apps, ask Build Agent to create a plan first. Review and approve before it starts building.
    Let Build Agent interview you
    For broad ideas, let Build Agent ask clarifying questions before planning. This produces better results than guessing at details yourself.
    Use specific ServiceNow terminology
    Say reference to sys_user instead of add a field for who ordered. Naming the table, field, scope, role, or artifact reduces interview cycles and produces more accurate output on the first attempt. Conversational prompts work well for early exploration, while precision works better as the build progresses.
    Draft offline
    Write prompts in a text editor, refine them, then paste into the chat, which saves prompts and can help to produce better results.
    Develop incrementally
    Develop each page or feature in separate chats. Implement and test, then start a new conversation for the next feature.
    Use markdown
    Place a markdown file (for example, named GUIDE_*.md or BUILD_AGENT_RULES.md) in your project directory. Build Agent reads these grounding files and follows your conventions throughout the session.
    Note:
    Markdown for Build Agent is currently available only in the ServiceNow IDE. Teams that get the most value from Build Agent markdown files document their organizational standards in these files, including the following:
    • Naming conventions: table names, field names, business rule naming patterns, and scope prefixes
    • Technical standards: coding practices, preferred patterns, and anti-patterns to avoid
    • Development cadence: processes, update set management, and code review requirements
    • Last-resort actions that require explicit approval: creating new tables, changing ACLs or roles, modifying system properties, and altering base system business rules
    Use ESLint
    Use ESLint on the ServiceNow AI Platform to define your preferred coding style, and ask Build Agent to manage and enforce the ESLint configuration, for example using snake case for variables.