Create Knowledge Article

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

With no annotations, description partially covers traits: default workflow state, body formats, and importance of creation. However, lacks details on permissions, side effects, rate limits, or error conditions. Adequate but not comprehensive.

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?

Four concise sentences front-load the main action and quickly cover body formats and workflow state. No redundant information; every sentence serves a purpose.

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?

With 9 parameters and no output schema, description covers core aspects but misses details on return values, additional_fields usage, and instance selection. Adequate for basic understanding but leaves gaps for complex use.

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 covers 100% of parameters. Description adds value by explaining that HTML is more common and that wiki is alternative. Does not fully describe additional_fields, but overall enhances understanding beyond 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?

Clearly states 'Create a new knowledge article' with verb and resource. Differentiates from siblings by mentioning default draft state and referencing publish_kb_article for publishing. Distinguishes itself from update_kb_article and list_kb_articles.

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?

Provides explicit guidance: 'Use publish_kb_article to make it visible to end users.' Also notes default draft state. Could be improved by mentioning when to use update_kb_article or alternatives, but it offers clear context for the primary usage.

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