Create Comment

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

Annotations already indicate readOnlyHint=false, signaling a write operation. The description adds value by specifying the requirement for 'insert comment' capabilities and the constraint of not providing both parent and discussion_id. This goes beyond the 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?

The description is two sentences long, with the purpose and key requirement in the first sentence and a critical constraint in the second. Every sentence earns its place, and it is front-loaded with the verb and resource.

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 complexity of the rich_text parameter, the schema covers it thoroughly. The description lacks mention of return values or error handling, but for a creation tool with no output schema, it provides sufficient context for an agent to invoke it correctly.

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 the schema already documents each parameter. However, the description adds crucial semantic information about the mutual exclusivity of parent and discussion_id, which is not explicitly stated in the schema. This compensates beyond the baseline 3.

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 action ('Create a comment') and the resource ('in Notion'). It distinguishes from siblings by specifying the unique operation, as there is no other create comment tool. The mention of two target options (page or discussion_id) adds specificity.

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 provides clear context for parameter selection by stating that either parent or discussion_id can be used, but not both. While it does not explicitly mention alternatives like notion_retrieve_comments for reading, the mutual exclusivity guidance is helpful for correct invocation.

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