haops_create_doc_artifact

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

With no annotations, the description carries full burden. It only states the creation action and uniqueness, but fails to disclose behavior on duplicate artifact types (e.g., does it error or silently overwrite?), permissions needed, or side effects. This is insufficient for a mutation tool.

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 concise sentences, each adding value: first states purpose, second adds a key constraint. No unnecessary words.

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 the tool has 5 parameters and no output schema, the description is minimal. It covers basic purpose and a constraint but lacks usage guidance, error behavior, or description of return value. Adequate but not complete for a creation tool.

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%, so baseline is 3. Description adds no additional meaning beyond the schema; enum values for type and details on the 'verbose' parameter are already clear from schema descriptions.

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 'Create a new documentation artifact for a project', with a precise verb and resource. The constraint 'One artifact per type per project' differentiates it from sibling tools like haops_create_doc_section or haops_update_doc_artifact.

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?

Description implies creation of new artifacts and uniqueness constraint, but does not explicitly guide on when to use this vs haops_update_doc_artifact or how to handle duplicate types (error vs overwrite). No alternatives are named.

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