Build Agent tools
Summarize
Summary of Build Agent tools
Build Agent tools enhance application development within ServiceNow by supporting tasks such as semantic search, schema inspection, code search, planning, UI validation, database querying, and app navigation. These tools extend Build Agent’s capabilities during build sessions, helping developers efficiently manage and understand their applications.
Show less
Key Features
- Code search tool: Enables searching workspace files using exact text or regex to locate references to fields, scripts, or functions, aiding impact analysis before changes.
- Open app tool: Converts applications not originally developed in ServiceNow IDE, Studio, or SDK into Fluent format, allowing development within Build Agent by locating, converting, and adding apps to the workspace.
- Planning tool: Generates detailed, step-by-step development plans that can be refined interactively through feedback and iterations.
- Run query tool: Queries specific tables in the instance to return top records or insights, supporting data-driven development decisions.
- Semantic metadata search tool: Provides semantic search based on intent rather than keywords, helping find relevant files or applications. It operates implicitly by analyzing development tasks or explicitly via direct user requests. Requires Zurich Patch 9 or later.
- Table schema inspector tool: Retrieves full table schemas including fields, types, mandatory flags, and references, essential for understanding and validating table structures before development.
- UI validation tool: Detects and validates UI components built during development using Playwright MCP skills executed on Automated Test Framework (ATF) Cloud Runner. Available from Zurich Patch 10 in Studio and ServiceNow IDE; requires ATF test generator and Cloud Runner app installed.
- Web search tools: Includes web search for public web information and web fetch for retrieving content from specified URLs. Semantic search requires Zurich Patch 11 and must be enabled in Build Agent settings.
Practical Benefits for ServiceNow Customers
- Accelerate development by quickly locating code and application components across your workspace.
- Convert and integrate legacy or externally developed applications into the modern Fluent format for seamless Build Agent use.
- Leverage semantic search to find relevant resources based on intent, reducing duplication and improving discovery.
- Plan and refine development workflows systematically, ensuring clarity and alignment before implementation.
- Validate UI components automatically with integrated testing tools, improving quality and reducing manual effort.
- Gain insights into your database schema and query data directly to support informed development decisions.
- Access external knowledge and resources via integrated web search and content fetching capabilities, enriching your development context.
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.
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.
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.
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 need 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.
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.
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 Zurich Patch 11 and above to use the semantic search tool.
- The web search tool must be turned on in the Build Agent settings.