tigergraph__list_connections

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

There are no annotations describing side effects or read-only behavior. The description says 'List', which implies a non-destructive operation, but it does not explicitly state that the tool has no side effects or that it is safe to call without consequences.

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?

The description is two sentences, concise and to the point. Every word contributes to explaining the tool's function and configuration context, with no redundant or verbose phrasing.

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?

The tool has no output schema, so no return value documentation is needed. The description fully covers what the tool does and provides background on profile configuration, making it complete for an agent to decide to call it.

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?

The input schema has zero parameters, so there is nothing to explain. The description provides helpful context about how profiles are configured via environment variables, which adds value beyond the schema. Baseline for 0 params is 4, and this description slightly exceeds it.

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?

The description clearly states the tool's purpose: 'List all available TigerGraph connection profiles.' It is specific about the action (list) and the resource (connection profiles), leaving no ambiguity about what the tool does.

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?

The description does not explicitly mention when to use this tool versus alternatives like 'show_connection', nor does it provide guidance on scenarios where listing all profiles is appropriate. It is clear in its function but lacks comparative usage context.

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