tigergraph__clear_graph_data

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

The description prominently warns that the operation is destructive, permanent, and irreversible, and that it requires explicit confirmation. It also notes side effects (clears all data but keeps schema) and the ability to clear a specific vertex type. No contradictions with annotations (none provided).

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 well-structured with headers and bullet points, effectively separating purpose, usage, warnings, and tips. The length is justified given the destructive nature and the need to convey critical safety information without being verbose.

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 description provides sufficient context for correct selection and use, including related tools (drop_graph, delete_nodes) for alternatives and warnings about backups. While it doesn't describe return values, no output schema exists, and the destructive nature makes the provided information complete for safe invocation.

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 are described in the schema, and the description adds extra context beyond the schema: confirm must be true, vertex_type restricts clearing to a specific type, and profile/graph_name have defaults. The Quick Start example reinforces usage.

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: clearing all data from a graph while preserving schema. It explicitly mentions the destructive nature and distinguishes from drop_graph. The 'Use When' section further clarifies applicable scenarios.

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?

Provides explicit 'Use When' scenarios, a Quick Start code example, and operational tips (e.g., needing confirm=true, alternative to drop_graph). This gives an agent full guidance on when and how to invoke the tool.

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