updateJournal

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

With no annotations and a terse description, there is zero disclosure of behavioral traits such as idempotency, side effects, authentication requirements, or error conditions.

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 short (two words), but this under-specification is not valuable conciseness. It lacks essential information, making it poor structure.

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 the absence of annotations, output schema, and meaningful parameter documentation, the description is entirely inadequate for the tool's complexity. It provides no guidance on return values, side effects, or usage.

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 complex parameters with no descriptions, and the tool description does not explain any parameter meaning. Schema description coverage is 0%, and the description fails to compensate.

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 'Update journal' merely restates the tool name without specifying what a journal is or what updating entails. It provides no additional context to distinguish it from sibling tools like updateIssue or updateProject.

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 guidelines are provided about when to use this tool, when not to, or how it compares to alternatives. The description is entirely silent on usage context.

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