create_note

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

No annotations are provided, so the description carries the full burden. It explains the creation action and optional attachments, but does not disclose behaviors like error handling for invalid record IDs, idempotency, or permissions. The return type is mentioned, but depth is limited.

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 with a docstring format. It front-loads the purpose, then lists arguments and return, all in few sentences. No redundant or unnecessary information.

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?

The tool has 5 parameters (1 required) and an output schema, so the description covers creation, parameter roles, and return value. It is complete for basic usage but could include more context on error conditions or validation of attached IDs.

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 coverage is 0%, so the description must compensate. The Args section clearly explains each parameter: body is required content, and contact_id, candidate_id, company_id, job_id are optional IDs to attach the note. This adds meaning beyond the schema's type/default info.

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 verb and resource: 'Create a note in Crelate and optionally attach it to a record.' It distinguishes from sibling tools like create_candidate which create different entities, making the purpose unambiguous.

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 usage for creating notes with optional attachments, but lacks explicit guidance on when not to use this tool (e.g., if only viewing notes) or alternatives. However, the context of sibling tools suggests no other note-creation tool exists.

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