Create note

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

No annotations provided, so description carries burden. It discloses linking behavior and side effect for work items appearing on client timeline, but does not cover auth requirements, 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?

Two sentences, first sentence states purpose and optional linking, second adds specific behavior. No wasted words. Front-loaded and efficient.

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 7 parameters and no output schema or annotations, description provides core purpose, linking behavior, and a side effect. Lacks details on error cases or prerequisites for AuthorEmailAddress, but adequately covers the main functionality.

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 86%. Description adds meaning to Timelines by explaining optional linking and side effect for work items. It also reinforces optionality. For Subject (missing schema description), description does not compensate, but overall adds value 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?

Description clearly states verb 'Create a note in Karbon' and specifies optional linking to work items, contacts, organizations, or client groups. Differentiates from sibling tools like create_contact or create_work_item by resource type.

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?

Implied usage: when you need to create a note. No explicit guidance on when to use this vs alternatives or when not to use it. Sibling tools create different entities so differentiation is clear by name, but description lacks contextual cues.

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