ae_health

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 states that the tool checks reachability and returns version/project info, but does not disclose what happens on failure (e.g., error message, exception), whether side effects exist, or prerequisite conditions (e.g., After Effects must be open).

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 a single, well-formed sentence that front-loads the action and the return value. No extraneous words.

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?

Given the simple nature of a health check with no parameters, the description provides the key outputs (AE version, project info). However, it could specify the return structure (e.g., object with fields) for completeness.

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 schema has zero parameters with 100% coverage, meeting the baseline of 4. The description adds no extra parameter meaning since none exist, but the purpose is 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?

The description explicitly states 'Check whether the After Effects CEP bridge is reachable' with a specific verb and resource, and distinguishes from siblings like 'ae_exec' (execute commands) and 'ae_scene_info' (scene info) by focusing on connectivity health.

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 implies usage as a precondition (e.g., before other operations), but does not explicitly state when to use or not use this tool versus alternatives. However, for a health check, the context is clear.

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