create_milestone

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

No annotations are provided, so the description must carry the burden. It only clarifies that the description field is plain-text and not Markdown. It fails to disclose return behavior, side effects, permissions, or any other runtime effects beyond creation.

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?

Two sentences: the first states the primary action, and the second clarifies a critical constraint on the description parameter. No extraneous information; every word 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 purpose and a key parameter detail but lacks information on return values (e.g., does it return the milestone ID?), prerequisites (e.g., board must exist), and any implicit constraints on due dates. Given the tool's simplicity, it is somewhat complete but has clear gaps.

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 schema description coverage is only 20% (only the description parameter has a description). The tool description adds meaning only for the description parameter, stating it should be plain-text and not Markdown. The other four parameters (name, boardId, dueStart, dueEnd) receive no additional explanation, so the description does not compensate for the low coverage.

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 purpose: 'Create a new milestone in a board.' It also distinguishes from the sibling tool edit_document_content by specifying that the description field is plain-text and to use edit_document_content for rich content.

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 implicitly says when to use this tool (to create a milestone) and provides an explicit alternative for rich document content, which helps the agent decide. However, it does not explicitly state when not to use this tool or mention other alternatives.

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