Skip to main content
Glama
tigergraph

tigergraph-mcp

Official
by tigergraph

tigergraph__get_query_description

Read-onlyIdempotent

Retrieve the descriptions of one or more installed TigerGraph queries, including their parameters, to clarify query purpose and support documentation.

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
NameRequiredDescriptionDefault
profileNoConnection profile name. Omit to use the active default profile. Use 'list_connections' to see available profiles.
graph_nameNoName of the graph. If not provided, uses default connection.
query_nameNoName of the query to read. Pass 'all' (default) to read descriptions for every query.all

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.2

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false). The description adds genuine value beyond that by disclosing 'Requires TigerGraph 4.0+,' a version prerequisite not present in the schema or annotations. It could also mention behavior for nonexistent queries, but with annotations carrying the safety burden, the added version constraint earns a strong score.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-organized with clearly labeled sections (Use When, Quick Start, Tips, Related Tools) and front-loads the core purpose. It is slightly longer than necessary with some redundancy between the Tips and the schema's parameter descriptions, but every section serves a navigational purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only metadata tool with three well-documented parameters and no output schema, the description covers the essentials: purpose, version requirement, use cases, a concrete example, and related tools. The return shape is adequately implied by the first sentence, and no critical information for invoking the tool correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3 and the schema already documents all three parameters including the 'all' default for query_name. The description reinforces this with a Quick Start example and the tips, adding marginal value but not meaningfully compensating beyond what the schema already provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Get the description and parameter descriptions of one or more installed queries,' which is precise and unambiguous. It distinguishes itself from siblings like get_query_metadata by implying that this tool provides descriptions while get_query_metadata provides types, though this differentiation is implied via the pairing tip rather than stated explicitly in the purpose sentence.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'Use When' section lists three concrete scenarios (discovering query behavior, building documentation, understanding parameters), and the Tips section names alternatives and complements (get_query_metadata, update_query_description). It provides clear context but lacks an explicit 'when not to use' exclusion, so it falls just short of the top score.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools