add_confluence_comment

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses a non-obvious behavior — Markdown is automatically converted to Confluence storage format (HTML) — and lists supported formatting, but it says nothing about required permissions (check_confluence_permissions exists as a sibling), notification side effects, or what the call returns.

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 sentences, front-loaded with the purpose before the requirements. It is efficient, though the Markdown formatting guidance is duplicated verbatim in the schema and could have been trimmed.

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 2-parameter tool with no output schema this is adequate, but there is a gap: it promises an 'inline' comment while the schema offers only pageId and markdownContent with no anchor or selection parameter, which may mislead an agent about what can actually be placed. Permission requirements and return value also remain unaddressed.

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 description coverage is 100%, so both parameters are already fully documented in the schema, including the Markdown formatting examples and the HTML conversion note. The description restates that same information rather than adding new meaning, so the baseline 3 applies.

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?

States a specific verb and resource ('Add an inline comment to an existing Confluence page') and the Confluence context implicitly separates it from the sibling jira_add_comment. It does not, however, clarify whether 'inline' means an anchored/highlighted comment versus a footer comment, nor does it name any sibling explicitly.

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 gives a hard precondition for the content parameter ('REQUIRED: Always provide Markdown content') and implies the page must already exist, but it never says when to use this tool versus create_confluence_page, jira_add_comment, or other siblings, and gives no exclusions or permission prerequisites.

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