Agent Tool: Difference between revisions
| Line 7: | Line 7: | ||
The get-summary tool returns a high-level summary about one of many predefined subjects related to the {{software}} 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. | The get-summary tool returns a high-level summary about one of many predefined subjects related to the {{software}} 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 {{software}} knowledge base. | |||
====get-page==== | |||
The get-page tool retrieves and returns the full content of a specific {{software}} 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 {{software}}'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== | ==API== | ||
Revision as of 12:46, 12 October 2026
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: Validate Tygron API Endpoint.
- validate-query: Validate Tygron TQL Query.
- execute-query: Execute TQL Query in your connected Project session.
- execute-endpoint: Execute API Endpoint in your connected Project session.
Client Interface
- get-screen: Take a screenshot of a window of the Tygron Client
- go-to-location: Navigate in the 3D Visualization to a specific location.
- open-panel: Open a specific Editor Panel
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