fmod_Event_getCursorPosition

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

With no annotations, the description must disclose behavioral traits. It mentions it retrieves cursor position and returns a number, but does not state whether it is read-only, side effects, prerequisites (e.g., event must be loaded), or response format beyond 'number'. The reference '[method · Event.getCursorPosition]' adds little value.

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 one sentence plus a reference. It is concise but could be more structured (e.g., separate return value and usage note). The reference is not essential.

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 moderate complexity and no output schema, the description covers the return value but lacks preconditions and interaction details. An AI agent might need more context about event state or target format (path vs GUID), though the schema handles the latter.

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 100%, but the description adds meaningful constraints: the 'parameter' must be the event's Timeline or GameParameter, which is not obvious from the schema's type definition (string|number|boolean). This clarifies valid values beyond the schema.

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 states it retrieves the cursor position and returns a number. The name 'fmod_Event_getCursorPosition' and parameter constraints (must be Timeline or GameParameter) distinguish it from sibling tools like fmod_Timeline_getCursorPosition and fmod_GameParameter_getCursorPosition, though not explicitly.

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?

No guidance on when to use this tool versus alternatives like fmod_Timeline_getCursorPosition or fmod_GameParameter_getCursorPosition. The description only explains what it does, not usage context or exclusions.

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