aras_new_revision

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

The description discloses the side effects of the operation: it performs a lock/version/unlock sequence, which is a key behavioral trait. It also notes that the operation is disabled in read-only mode. This is more transparent than many tool descriptions, though it does not mention failure modes or return values."

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, concise sentence that front-loads the main action and includes essential constraints. It wastes no words and is immediately understandable."

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?

While it captures the core purpose and side effects, it omits details about prerequisites (e.g., item must be versionable), potential errors, and the expected response. Given the tool's moderate complexity, the description provides decent context but is not fully complete."

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 input schema has two parameters (id and itemType) with no descriptions. The tool description does not elaborate on what these parameters mean or how they relate to the revision creation. Since schema coverage is 0%, the description fails to compensate for this lack of parameter documentation."

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 the tool's function: creating a new revision of a versionable item. It explicitly mentions the lock->version->unlock sequence, which distinguishes it from other Aras tools like promote_item or release_item. The verb 'creates' is specific and the resource context (versionable item) is evident."

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 (when you need a new revision) but does not explicitly contrast with alternatives or state when not to use it. It mentions 'disabled in read-only mode', which is a usage constraint, but lacks explicit guidance on choosing this over other revision-related tools."

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