Build Agent tools
Summarize
Summary of Build Agent tools
Build Agent tools enhance your application development within ServiceNow by supporting key tasks such as semantic search, schema inspection, code search, planning, UI validation, database querying, app navigation, and script execution. Each tool extends Build Agent’s capabilities to streamline your build sessions and improve development accuracy and efficiency.
Show less
Key Features
- Code search tool: Enables searching workspace files using exact text or regex patterns to locate references to fields, scripts, or functions, helping assess change impact before implementation.
- Open app tool: Converts applications not originally developed with ServiceNow IDE, Studio, or SDK into Fluent format, allowing development within Build Agent by locating and adding the app to your workspace.
- Planning tool: Generates detailed, step-by-step development plans that you can iteratively refine with feedback to finalize your application build strategy.
- Rollback script tool: Allows undoing of previously executed scripts within the current session to restore your instance to a prior state if unexpected results occur. Requires Australia Patch 5 or later.
- Run query tool: Queries specific instance tables and returns top records or insights to support data exploration during development.
- Run script tool: Creates and executes server-side scripts for advanced operations beyond querying, with script preview and approval before execution. Requires Australia Patch 5 or later.
- Semantic metadata search tool: Facilitates natural language searches to find relevant files or applications based on meaning rather than keywords. Supports implicit and explicit searches. Requires Australia Patch 2 or later.
- Table schema inspector tool: Provides detailed table field information including names, types, mandatory flags, and references to help understand and verify table structures.
- UI validation tool: Detects and validates UI components built during the session using Playwright MCP skills and Automated Test Framework (ATF) Cloud Runner. Available from Australia Patch 3 in Studio and IDE. Requires ATF test generator and Cloud Runner apps installed.
- Web search tool: Enables external public web searches; complemented by web fetch tool to retrieve content from specified URLs. Requires Australia Patch 4 or later and must be enabled in settings.
Key Outcomes
By leveraging Build Agent tools, ServiceNow customers can accelerate development with smarter search capabilities, ensure code and UI quality, manage application schemas confidently, and perform advanced scripting and querying securely. These tools help reduce manual effort, avoid duplication, and maintain governance through controlled script execution and rollback options, ultimately leading to more reliable and efficient application builds within your ServiceNow environment.
Build Agent tools support application development tasks such as semantic search, schema inspection, code search, planning, UI validation, database querying, app navigation, and script execution. Each tool extends what Build Agent can do during a build session.
Code search tool
The code search tool searches workspace files by exact text or regex patterns. Use the code search tool to find references to a field, script, or function across your app, and to understand the impact of a change before making it.
Open app tool
For applications that were not developed using the ServiceNow IDE, ServiceNow Studio, or the ServiceNow SDK, you must convert them into Fluent format to enable development within the Build Agent. You can prompt the Build Agent to use the open app tool to locate the application you want. Alternatively, you can search for an application directly within the Build Agent, and it will automatically use the open app tool. The open app tool can find an application, convert it to Fluent format, and then add the converted app to your workspace.
Planning tool
Build Agent includes a planning tool that creates a detailed, step-by-step plan for your application development. You can refine the plan iteratively by prompting for changes and providing feedback until you reach a final version.
Rollback script tool
The rollback script tool reverts a previous run script tool operation on demand. After Build Agent runs a script, it returns a rollback context you can use to undo that run. Use the rollback script tool when a script run produces an unexpected result and you want to restore your instance to its previous state.
Run query tool
Build Agent can use the run query tool to query a specific table within your instance and return the top five records or derive specific insights.
Run script tool
The run script tool generates and runs a server-side script on your instance during a build session. Use the run script tool when you need Build Agent to perform an operation that goes beyond querying a table. For example, to retrieve data that requires custom logic, or to create something dynamically when no other tool covers the task.
Semantic metadata search tool
The semantic metadata search tool is part of Build Agent's tool registry. Semantic search enables you to describe what you're looking for without providing the exact file name or keyword. For example, you can search for files related to incident process management, and the tool finds relevant results based on semantic understanding, not just keyword matching. Indexing keeps results current as your instance evolves.
Build Agent uses semantic search in two ways:
- Implicit search
- Build Agent determines when to use the semantic search tool based on your development task. When you describe what you want to accomplish, Build Agent searches for existing files and applications that match your intent. It then presents the results in a plan for your approval, which helps prevent duplicate content creation.
- Explicit search
- You can directly request a search by asking Build Agent to find something on your instance. Use explicit search when you want to locate specific files, applications, or knowledge without making changes.
Table schema inspector tool
The table schema inspector tool returns every field on a table, including field names, types, mandatory flags, and reference targets. Use the table schema inspector tool to understand a table's structure before adding fields or writing logic against it, and to verify the schema of base system tables.
UI validation tool
Build Agent detects UI components created during the build process, then analyzes and validates the UI using the UI validation tool. The tool automatically uses skills available in the Playwright MCP and executes them on the Automated Test Framework (ATF) Cloud Runner infrastructure.
Web search tool
Two Build Agent tools support external search.
- Use the web search tool to find information on the public web.
- Use the web fetch tool to retrieve content from a URL that you supply.
- You must have Australia Patch 4 and later to use the web search tool.
- The web search tool must be enabled in the Build Agent settings. For more information, see Configure web search.