Build Agent tools
Summarize
Summary of Build Agent tools
Build Agent tools in ServiceNow's Zurich release support various application development tasks including semantic search, schema inspection, code search, planning, UI validation, database querying, and application navigation. These tools extend Build Agent capabilities during development sessions, helping customers streamline and enhance their app building process efficiently.
Show less
Key Features
- Semantic Search Tool: Enables intuitive searches based on intent rather than exact keywords or file names. It operates in two modes:
- Implicit Search: Build Agent proactively suggests relevant files and apps based on your described development goals to avoid redundant content creation.
- Explicit Search: Allows direct user requests to find specific files or knowledge on the instance without making changes.
Requirement: Zurich Patch 9 or higher is needed to use semantic search.
- Table Schema Inspector Tool: Provides detailed metadata on table fields including names, types, mandatory flags, and references. Useful for understanding table structure before modifications or logic implementation.
- Code Search Tool: Searches workspace files via exact text or regex patterns to locate references to fields, scripts, or functions. Helps assess impact of code changes.
- Planning Tool: Generates iterative, detailed step-by-step plans for app development, allowing refinement through feedback and prompts.
- UI Validation Tool: Detects and validates UI components built during development using Playwright MCP skills and Automated Test Framework (ATF) Cloud Runner infrastructure. Can be triggered explicitly for ATF cloud runner tooling.
Requirements: Zurich Patch 9+ for usage, Zurich Patch 10+ for ServiceNow Studio integration, and installation of ATF test generator and Cloud Runner apps.
- Run Query Tool: Queries specific tables to retrieve top records or derive insights, facilitating targeted data examination during development.
- Open App Tool: Converts applications not originally developed in ServiceNow IDE, Studio, or SDK into Fluent format to enable Build Agent development. It locates, converts, and adds apps to the workspace automatically.
Practical Benefits for ServiceNow Customers
- Accelerate app development by leveraging semantic understanding to find relevant resources and avoid duplication.
- Gain clear visibility into table schemas and code dependencies, reducing errors and improving design accuracy.
- Use planning and UI validation tools to ensure development is structured and interfaces meet quality standards.
- Query data and manage existing applications seamlessly within Build Agent, enhancing development workflow efficiency.
- Ensure compatibility and readiness by meeting patch and app installation prerequisites for advanced tool usage.
Build Agent tools support application development tasks such as semantic search, schema inspection, code search, planning, UI validation, database querying, and app navigation. Each tool extends what Build Agent can do during a build session.
Semantic search tool
The semantic 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.
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, then presents the results in a plan for your approval. This 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.
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.
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.
UI validation tool
Build Agent detects 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.
- The ATF test generator and Cloud Runner app must be installed on the instance to use the UI validation tool.
- You must have Zurich Patch 9 or higher to use the UI validation tool.
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.
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.