GSAP TextPlugin

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

No annotations provided; description is minimal. It does not disclose behavioral traits like DOM modification, library dependencies, or side effects beyond text replacement. Lacks depth for a tool with complex options.

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?

Three sentences, front-loaded with purpose, no redundancy. Every sentence adds value.

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?

Despite complexity (7 params, nested objects, no output schema, no annotations), the description is too brief. Does not cover parameter details, output behavior, or import requirements. Completeness is insufficient.

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?

Schema coverage is low (29%); description adds meaning to 'type' parameter (replace vs scramble) but does not explain 'options', 'ease', 'duration', or 'includeImports'. Partially compensates for low coverage.

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 it animates text content replacement character-by-character using TextPlugin or ScrambleTextPlugin, with specific verbs and resources. It distinguishes from sibling gsap_splittext for split characters.

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?

Explicitly states when to use 'replace' for typewriter effect and 'scramble' for scramble reveal, and directly advises using gsap_splittext for animating split characters.

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