Agent Tool
Read more about Beta features.
AI Agents in the Tygron Platform can use the following Tools:
Wiki
get-summary
The get-summary tool returns a high-level summary about one of many predefined subjects related to the Tygron Platform and its ecosystem. It accepts a single required parameter, subject, which must be one of an extensive list of topics (e.g., Watershed, Stakeholder, TQL, Heat Stress, Flooding, 3D Viewer, Scenario, etc.). It is typically used as a first step to quickly gather contextual information about a concept before diving deeper with other tools like the wiki search or API endpoints.
search-page
The search-page tool searches both the titles and contents of wiki pages for a provided text query. It takes a single required parameter called query (a string) that specifies what you're looking for. The tool returns all matching wiki pages, making it useful for finding relevant documentation within the Tygron Platform knowledge base.
get-page
The get-page tool retrieves and returns the full content of a specific Tygron Platform wiki page by its exact title. You must provide the title parameter, which should match the name of an existing wiki page (e.g., "TQL", "Watershed", "3D Tiles"). It is useful for looking up detailed documentation on any platform feature, concept, or workflow when you need more in-depth information than a get-summary provides.
get-image
The get-image tool retrieves and displays an image file that is hosted on the Tygron Platform's documentation wiki. You must provide the file parameter with the exact wiki filename (e.g., "tql-diagram.png") to fetch the corresponding image. It is useful for viewing diagrams, screenshots, or illustrations referenced within wiki pages when you need a visual explanation of a concept or workflow.
API
validate-endpoint
The validate-endpoint tool checks whether a given API Endpoint URL is syntactically correct and accessible within the Tygron Platform, without actually executing it. You provide the endpoint parameter (which can be a relative or full URL) and optionally a data parameter containing a JSON-encoded string if the request would be an HTTP POST. It is useful for verifying that your endpoint path, method, and payload structure are valid before running the actual operation with the execute-endpoint tool, helping you catch errors early.
validate-query
The validate-query tool checks whether a single TQL query is syntactically correct and valid within your current project, without actually executing it. You provide the query parameter containing one TQL statement, and the tool returns feedback on its correctness—keeping in mind that TQL has its own distinct syntax and is not SQL. It is useful for catching typos or structural errors before you commit to running a query with the execute-query tool, especially when performing UPDATE operations that would modify project data.
execute-query
The execute-query tool runs one or more TQL queries directly against your Project's data, performing actions such as selecting records or updating attribute values. You provide the queries parameter with one or more unique TQL statements separated by commas, and an optional value parameter that supplies a numeric value for a single UPDATE query (ignored for SELECT queries).
execute-endpoint
The execute-endpoint tool performs actual API operations against your Project, allowing you to get, add, remove, or edit project data through REST-style endpoint calls. You provide the endpoint parameter (a relative or full URL) and optionally a data parameter containing a JSON-encoded string for HTTP POST requests; the tool automatically handles the correct authorization token and HTTP method based on the endpoint. It is best used after confirming your request with validate-endpoint to ensure the URL structure and payload are correct before making changes that could affect your project data.
Client Interface
get-screen
The get-screen tool captures and returns a live screenshot of the current Tygron Client, including both the Editor panels and the 3D/2D map viewer. It also provides the current Viewer's coordinate reference system (CRS EPSG:3857) coordinates for the visible area, giving you spatial context about what is currently displayed. It is especially useful as a first step before interacting with the interface.
go-to-location
The go-to-location tool navigates the Viewer interface to a specific geographic point specified by x and y coordinates, which can be provided in CRS EPSG:3857 or local project coordinate systems. It optionally accepts an id parameter to display a particular overlay at that location and a timeframe parameter (defaulting to 0) to set the temporal context for any time-dependent overlays shown.
open-panel
The open-panel tool opens a specific tab in the Tygron Platform's Editor interface, allowing you to directly access and manage items such as BUILDINGS, AREAS, NEIGHBORHOODS, OVERLAYS, and more. It requires a panel parameter specifying the exact panel name (in uppercase) and optionally accepts an id parameter to automatically select a particular item within that panel (e.g., opening NEIGHBORHOODS with id 3 selects). This tool is especially useful for quickly navigating to a specific section of the Editor without manually clicking through tabs.
How-to's
- How to configure a Chat Channel
- How to allow a Chat Channel to edit a project
- AI Chat tutorial
- Indicator Chat tutorial
See also
API Endpoints