Create Jedox Element

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

Annotations indicate readOnlyHint=false and destructiveHint=false, but the description adds context: explains element types (numeric, string, consolidated), children structure, weight semantics, and return value. No contradictions.

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 concise, structured with clear headings, front-loads the purpose, and includes only necessary details. Every line adds value, and the alternative note is efficiently placed at the end.

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 no output schema, the description includes the return shape ({ id, name, typeLabel }). It covers all parameters, conditional behavior (children only for consolidated), and the alternative tool. However, it omits error handling or prerequisites (e.g., dimension must exist).

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 60%, but the description covers all parameters in the Args section, adding meaning like weight behavior (1.0 for addition, -1.0 for subtraction) and the requirement that children must exist. It also notes the default type despite schema already having it.

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 'Create a single element (member) in a Jedox dimension,' specifying verb and resource. It differentiates from sibling 'jedox_bulk_create_elements' by noting the single vs. bulk distinction.

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 explicitly advises when to use an alternative: 'For creating many elements at once, use jedox_bulk_create_elements instead.' This provides clear guidance on tool selection.

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