Create Jedox Dimension

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

Annotations already indicate it's a write operation (readOnlyHint=false) but not destructive (destructiveHint=false). The description adds value by explaining the return format ({id, name}) and the need to save to disk, which is not obvious from annotations alone. 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 extremely concise, with only two sentences plus structured Args/Returns sections. It front-loads the core purpose and includes all essential information without any fluff. Every sentence serves a purpose.

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?

For a simple creation tool with two parameters, the description fully covers what the agent needs: purpose, required inputs, expected output, and subsequent steps. Missing output schema is compensated by describing the return structure. No gaps are apparent.

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% with parameter descriptions. The description enhances semantics by providing example dimension names ('Accounts', 'Periods', 'Regions'), adding practical context beyond the schema's technical constraints.

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 'Create a new dimension in a Jedox database' with example names like 'Accounts', 'Periods', 'Regions'. It clearly differentiates from sibling tools like jedox_create_element or jedox_create_cube, which target different resources.

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 provides a clear workflow: after creation, use jedox_bulk_create_elements to add members and then call jedox_save_database to persist. This guides the agent on when to use this tool and what steps follow. It doesn't explicitly state when not to use it, but the sequential context is helpful.

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