Create Knowledge Article

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds that the article is created in 'draft' state by default and notes the HTML/wiki body options, plus an 'IMPORTANT' emphasis that it creates a new article on the instance. This adds useful behavioral context 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 concise—about five sentences in three short paragraphs—and front-loads the core purpose. It avoids redundancy with the schema and provides the important publish hint efficiently.

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 9-parameter creation tool with nested objects and no output schema, the description covers the essential creation behavior, default state, and body format choices. It does not describe the return value (e.g., sys_id of the created article), which would be helpful, but the rich schema compensates for this gap.

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 100% schema coverage, the schema already documents all parameters. The description adds practical value by noting that HTML is the more common body format, helping users choose between text and wiki fields, and by confirming the default workflow_state matches the schema default.

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 begins with 'Create a new knowledge article in a specified knowledge base,' which is a specific verb+resource statement. It also mentions the default 'draft' workflow state, distinguishing it from the sibling tool publish_kb_article.

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 explicitly directs users to publish_kb_article for making articles visible, providing a clear alternative. It also mentions that HTML is more common than wiki, aiding format choice, though it does not explicitly exclude update_kb_article for modifying existing articles.

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