tigergraph__get_query_description
Retrieve descriptions for one or more TigerGraph queries, including their parameters, to understand query purpose and parameter meanings.
Instructions
Get the description and parameter descriptions of one or more installed queries. Requires TigerGraph 4.0+.
Use When: • Discovering what a query does and what each parameter means • Building query documentation • Understanding a query's parameters together with their descriptions
Quick Start:
{
"query_name": "getPersonFriends"
}Tips: • Pass 'all' (the default) to read descriptions for every query • Pair with 'get_query_metadata' to combine parameter types and descriptions • Set descriptions with 'update_query_description'
Related Tools: update_query_description, get_query_metadata, show_query
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile | No | Connection profile name. Omit to use the active default profile. Use 'list_connections' to see available profiles. | |
| graph_name | No | Name of the graph. If not provided, uses default connection. | |
| query_name | No | Name of the query to read. Pass 'all' (default) to read descriptions for every query. | all |