tigergraph__update_query_description
Update an installed query's description and optional parameter descriptions to document what it does, making queries self-describing for agents.
Instructions
Set a human-readable description for an installed query and, optionally, descriptions for each of its parameters. Requires TigerGraph 4.0+.
Use When: • Documenting what an installed query does and what its parameters mean • Making queries self-describing for agents and other consumers
Quick Start:
{
"query_name": "getPersonFriends",
"query_description": "Return the friends of a given person.",
"parameter_descriptions": {"personId": "ID of the person to look up"}
}Tips: • Query must be installed first • Omit 'parameter_descriptions' to set only the query-level description • Read it back with 'get_query_description'
Related Tools: get_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 | Yes | Name of the installed query to describe. | |
| query_description | Yes | Human-readable description of what the query does. | |
| parameter_descriptions | No | Per-parameter descriptions, keyed by parameter name (e.g. {"personId": "The id of the person to look up"}). |