Create a changelog entry

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

The description meaningfully extends the annotations by explaining default draft behavior, immediate publishing via status 'published', scheduling via a future published_at, and Markdown content. It does not mention response shape or error cases, but the non-idempotent, mutating nature is already signaled by annotations.

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?

Three short, front-loaded sentences deliver purpose, key status behavior, and content format with no filler. Every sentence earns its place.

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?

The description covers the core creation workflow, defaults, scheduling, and Markdown content, while required parameters are captured in the schema. Minor gaps like return value and error behavior are acceptable for a simple creation tool with no output 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?

With 67% schema coverage, the schema already documents several parameters, and the description adds the crucial interaction between status and published_at (draft by default, immediate publish, scheduled publish). It does not elaborate on the 'type' enum, but those values are self-descriptive.

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 opens with a specific verb and resource: 'Create a changelog entry in a project.' This clearly separates create_entry from its siblings (list_projects, list_entries, get_entry, update_entry, publish_entry) without needing to inspect schemas.

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?

There is no guidance on when to choose create_entry versus update_entry or publish_entry, and no explicit when-not-to-use conditions. The description does explain status behavior, but that is parameter usage rather than tool-selection guidance.

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