create_solution_article

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

No annotations are provided, so the description carries the burden. It adds useful context by specifying status and article_type values and noting HTML support in the body, but it does not disclose side effects, permission requirements, or validation behaviors.

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 front-loaded with a clear purpose sentence, followed by a structured Args list. It is slightly verbose but each line earns its place by explaining a parameter. No wasted words.

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?

While output schema exists, the description omits important context like needing an existing folder or relationship with categories. It explains parameters well but lacks usage prerequisites and any mention of validation or constraints beyond the 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?

Schema description coverage is 0%, but the description's Args block adds meaningful explanations for all six parameters, including enum-like meanings for status and article_type, HTML support for description, and optionality of tags. This significantly supplements the raw schema.

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 'Create a new solution article' with a specific verb and resource. This distinguishes it from sibling tools like create_solution_category or create_solution_folder.

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 implies use when creating a solution article but provides no explicit when/when-not guidance or alternatives. It does not mention prerequisites like needing a valid folder_id or relationships to other entities.

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