fmod_GameParameter_getCursorPosition

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

With no annotations, description carries burden. 'Retrieves' implies read-only, but no mention of preconditions, side effects, or error states. Adequate but minimal.

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?

Two concise sentences with a code reference. Slight typo ('parameter 's') but overall efficient and front-loaded.

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?

Covers purpose and return type but lacks explanation of cursor position units (e.g., seconds) and error conditions. Adequate for a simple getter with good parameter schema.

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%; parameter description in schema is sufficient. Description adds no additional semantics beyond the global user parameter context.

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?

Description clearly states it retrieves the cursor position of a global user parameter, distinguishing it from sibling tools like fmod_Event_getCursorPosition and fmod_Timeline_getCursorPosition. However, it does not explicitly differentiate from fmod_ParameterProxy_getCursorPosition.

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_Event_getCursorPosition or fmod_Timeline_getCursorPosition. Implicit from name but no explicit context or exclusion criteria.

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