create_document

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

No annotations provided, but description discloses important behavioral traits: folder prompting behavior, credential-dependent UX (JWT vs API-key), and skip option. Missing details like rate limits or error handling, but sufficient given no 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?

Three sentences, front-loaded with main purpose, and no wasted words. Efficiently communicates the key behavioral nuances without redundancy.

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 5 parameters and no output schema, the description covers folder selection, credential types, and skip behavior. Could mention HTML support for content or expected response, but overall adequate.

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 100%, but description adds value beyond schema by explaining how to find folder IDs (web URL, existing document) and the concept of interactive prompting. This enhances the agent's understanding of parameter use.

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 document in IT Glue for an organization' with a specific verb (create) and resource (document). It distinguishes from sibling tools like archive_document or search_documents by focusing on creation.

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 context on when to use skip_folder_prompt and explains the folder selection process based on credential type. However, lacks explicit guidance on when not to use this tool versus alternatives like using an existing folder from search.

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