tigergraph__get_node

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

No annotations are provided, so the description carries the full burden. It does not explicitly state that the operation is read-only, nor what happens when the vertex is not found (e.g., error vs. null return). The verb 'get' implies no mutation, but without explicit side-effect or error behavior, transparency is limited.

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

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

Description is concise, uses clear headings, and includes a helpful Quick Start JSON example. No redundant or extraneous content – every sentence carries purpose.

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

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

No output schema is provided, and the description does not indicate what the return value looks like (e.g., vertex attributes, null, or error). For a retrieval operation, this is a significant gap. The sibling tool 'has_node' exists for existence checks, but 'get_node's return contract is left unspecified.

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

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

All four parameters have schema descriptions, and the profile parameter adds cross-reference guidance ('Use list_connections to see available profiles'). Required fields are unambiguous. The description adds modest value beyond the schema but is accurate and clear.

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

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

States 'Get a single node (vertex) from a TigerGraph graph by its type and ID' – clear verb, resource, and required parameters. The 'Use When' section further clarifies intended use cases like retrieving a specific entity or verifying creation.

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

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

Includes a dedicated 'Use When' section listing four concrete scenarios, plus a 'Related Tools' list that helps orient the agent. While it does not explicitly say when not to use this tool, the provided use cases are sufficient guidance.

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