Artifacts searcher

The Artifacts Searcher tool searches and retrieves detailed information about APIs, application source objects, and database tables based on your query.

The Artifacts Searcher tool helps you locate technical details across APIs, application objects, and database tables. It supports filtering by source type and displays structured results in markdown format with the following columns:

  • Name
  • Type
  • Location
  • Source ID
You can use this tool to quickly find metadata and specifications for APIs, application objects, and database tables.
APIs
Find API documentation and usage guidelines that are stored in database tables to understand integration and usage.
Application objects
Retrieve metadata for application objects, such as properties and methods, from platforms like Salesforce and ServiceNow.
Database tables
Explore table structures, including column names and data types, and access API documentation stored in tables.
  • Access API documentation stored in tables for quick reference.
  • Retrieve application object details, including attributes and behaviors.
  • Explore table structures, such as column names and data types, to understand data organization.
Key highlights
  • Searches across API endpoints, application source objects, and database tables.
  • Displays detailed metadata, including source location and specifications.
  • Supports filtering by OpenAPI versions and API types.
  • Provides formatted markdown tables for easy reading.
The following operations are supported in the Artifacts Searcher tool:
Note: When you enter a prompt to search for an API, or a database table and the search results are not appropriate. Do the manual refresh to resolve this issue.

Search for API artifacts

Enter a prompt to search for application source artifacts. The tool searches for APIs matching the specified criteria and displays detailed information about their specifications and locations.

This operation displays a markdown-formatted table that contains API metadata.
Table 1. Parameters
Parameter Required Description
text Yes Search query for API names or descriptions.
source_type Yes Set to "API" for this operation.
Example prompts

  • List all APIs that support the OpenAPI 3 specification
  • Show me all APIs that have paths containing the word 'order'
  • What are all the APIs supporting user authentication operations?

Search for table artifacts

Enter a prompt to search for table artifacts. The tool displays database tables that match your criteria and displays schema and metadata.
Note: When you search for an artifact, the tool displays only the top five matches by default, even if more entries exist in the database for your query.
This operation displays a markdown-formatted table that contains table metadata.
Table 2. Parameters
Parameter Required Description
text Yes Search query for table names or descriptions.
source_type Yes Set to "endpoint_schema" for this operation.
Example prompts

  • search for available tables with name procurement_order
  • What are all the tables supporting order-related operations?
  • List all tables in the sales schema