Example prompts
Summarize
Summary of Example prompts
This documentation provides ServiceNow customers with example prompts and guidance for using Build Agent to create, extend, govern, and document applications on the ServiceNow AI Platform. It helps customers accelerate app development and governance by leveraging AI-driven prompting techniques tailored for common ServiceNow tasks.
Show less
Prompting Basics and Usage
- Each submission to Build Agent counts as a prompt; responses to clarifying questions also count, but plan approvals do not.
- Draft prompts carefully before submission to maximize value.
- Replace placeholders in example prompts with your specific app details.
Key Prompt Categories and Examples
- Plan: Request detailed app plans including tables, fields, roles, and business rules before creation.
- Prototype: Build applications with basic roles, flows, and UI based on given requirements.
- Brainstorm: Get suggestions for tables, flows, and catalog items for business problems.
- Extend: Add fields, business rules, or ACLs safely with review plans before applying changes.
- Learn: Explain ServiceNow concepts with examples for better understanding.
- Debug: Diagnose errors with stepwise reproduction, log review, and known issue checks.
- Document: Generate README files, app summaries, and user guides.
- Test: Create Automated Test Framework (ATF) tests for app functionalities.
- Security: Add role-based access controls and enforce ACLs with pre-approval plans.
- Flow and Diagram: Create workflow automations and Mermaid ER diagrams for app structure visualization.
Getting Started Recommendations
- Prototype a simple app: Describe straightforward apps, review the plan, then approve to build.
- Document existing apps: Summarize architecture and key components without risk.
- Extend existing apps or base tables: Safely add fields, business rules, or ACLs to familiar apps or global tables.
Governance and Security Integration
Embedding governance requirements in prompts ensures secure, compliant, and quality applications. Customers are encouraged to explicitly include:
- Security roles and ACL enforcement
- Data sensitivity and encryption
- Audit logging for workflows
- Compliance standards (e.g., GDPR)
- Testing requirements with ATF
- Documentation for governance reviews
Additional Use Cases and Prompt Extensions
After initial app creation, continue refining by prompting to:
- Improve user interfaces
- Create comprehensive test plans (QA, UAT)
- Generate release notes and training materials
- Draft change management and data migration plans
- Optimize workflows and prepare executive summaries
Practical Benefits for ServiceNow Customers
- Accelerate app development with ready-to-use prompt templates.
- Ensure security and compliance by integrating governance into AI-assisted development.
- Minimize risk by reviewing plans before applying changes.
- Enhance maintainability with generated documentation and testing artifacts.
- Leverage AI assistance to handle common tasks such as debugging, UI creation, and access control.
Explore example prompts for building apps, as well as adding governance, UI and other ServiceNow metadata to help you get started with prompting Build Agent.
To learn more about prompting, see this Community article on The fastest way to learn Build Agent prompting? Ask Build Agent.
Prompting overview and tips
Prompts are counted each time you submit a message to Build Agent. If Build Agent asks a clarifying question and you respond, that response counts as a prompt. Approving a plan that Build Agent presents does not count as a prompt. To get the most value from each prompt, draft your message in a text editor before you submit it.
For more guidelines on prompting, see General guidelines for Build Agent.
Prompt reference
Use the following prompts as starting points for common Build Agent goals. Replace the bracketed placeholders with your specific details.
| Goal | Prompt |
|---|---|
| Plan | I want to build [app idea]. Create a detailed plan including tables, fields, roles, and business rules. Wait for my approval before creating any files. |
| Prototype | Build me a [app name] application with [key requirements]. Include basic roles, flows, and a working UI. |
| Brainstorm | I need to build something for [business problem]. What tables, flows, and catalog items would I need? |
| Discover | List the metadata types you can create or edit in this scope. |
| Coach | For [metadata type], coach me on an ideal prompt and common pitfalls. |
| Extend | Open [app name]. Add a field called [field] to the [table] table. Update the ACLs so only [role] can edit it. |
| Extend out-of-box | Add a custom field to the incident table called [field]. Create a business rule that [logic]. Show the plan before applying. |
| Learn | Explain [ServiceNow concept] to me. What is it, when do I use it, and show me an example. |
| Debug | I'm seeing this error: [paste exact error]. This happens when: [describe scenario]. Before suggesting fixes: 1) Help me reproduce this consistently. 2) Review the debugger output and logs. 3) Check for access or configuration issues. 4) Examine if this is a known issue. |
| Document | Create a README with setup instructions and a user guide for this application. |
| Test | Create ATF tests to validate [specific functionality] works correctly. |
| Security | Add role-based access so only [role] can edit; others are read-only. Show the plan and ACL changes before applying. |
| Diagram | Generate a Mermaid ER diagram showing all tables, fields, and relationships in this application. |
| Flow | Create a flow that triggers when [condition] and sends an email notification to [recipient] with [details]. |
| Ideal prompt | Now that you've built this app, what's the ideal prompt to recreate it from scratch? |
Get started with prompting
- Prototype a simple app: Describe a straightforward application in one or two sentences. Review the plan that Build Agent presents, then approve it to start the build. This approach lets you learn the workflow with low risk.
- Document an existing app: Open a custom scoped app and ask Build Agent to summarize its architecture, data model, roles, and key components. This produces useful documentation with no risk to the app.
- Extend an existing app or base system table: Add a field, a business rule, or an ACL to an app you're familiar with. Build Agent supports global-scope tables such as Incident, as well as custom and ServiceNow Store apps.
Starter prompts
Use the following prompt patterns to get started with common Build Agent tasks. Replace the bracketed placeholders with your specific details.
- Extend safely
- Open [app name]. Before making changes, document the current state. Then add [feature]. Return a plan for approval. After changes, generate ATF tests and a README.
- Prototype
- Build me a [app name] application with [requirements]. Include basic roles, a working UI, and flows for [automation]. Then generate ATF tests and documentation.
- Extend base system
- Add a custom field called [field] to the incident table. Create a business rule that [logic]. Show the plan and ACL changes before applying.
- Document
- Summarize the app architecture, data model, roles, and key UI components. Don't make any changes.
Additional prompt suggestions
- Improve generated user interfaces
- Create ATF tests
- Create QA and UAT test plans
- Create a summary of all application functionality
- Add additional industry-specific use cases
- Create an announcement
- Create a user guide
- Generate release notes
- Draft change management plans
- Create training materials for end users
- Build data migration plans
- Generate workflow optimization suggestions
- Prepare executive summary for stakeholders
Example Build Agent prompt to build an app
Prompt: Create an application that handles several types of issues related to cash management. Create a custom data model with tables for each type of request. Add fields that are typical for these types of issues to each table. Request tables should extend the Task table. Create custom states for each request type to track issue resolution.
Example Build Agent prompt to add security to an app
- Requesters who submit issues and can only view their own requests.
- Fulfillers who can view and edit all requests.
Example Build Agent prompt to add business rules to an app
Prompt: Create business rules for each request that is triggered by state changes in the workflow. Design the business rules to work together to create business processes aligned to industry best practices for each type of issue.
Example Build Agent prompt to generate different UIs for an app
Prompt 1: Create an easy to use UI for users with the cash management fulfiller role to view all issues, update and complete them.
Prompt 2: Create a UI for cash management requesters to submit issues and view or edit issues that they have previously created.
Example prompts for governance
Prompting with governance requirements helps produce secure and compliant applications on the ServiceNow AI Platform. By embedding governance requirements directly into your prompts, you help the AI produce results aligned with your organizational standards for security, compliance, and quality.
For more information on governance, see Build Agent governance.