roiq_add_property

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

With no annotations, the description carries full burden. It mentions adding a property but does not disclose behavioral traits like whether existing properties are checked, if operations are reversible, or required permissions. The type list is helpful but insufficient.

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 one informative sentence plus a type list, efficient with no filler. However, it could be more structured to improve readability.

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 annotations or output schema, the description is incomplete. It fails to explain parameter interactions, required fields beyond type, or what the tool returns. More detail is needed for correct invocation.

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 description must add meaning. It only describes the 'type' parameter with its enum values. Other parameters (key, label, options, pipelineId) are unexplained, leaving significant gaps for an agent.

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 tool adds a property (data column) to a DB and lists allowed types. It distinguishes from siblings like roiq_add_card and roiq_create_db by specifying the resource (property vs card or DB). However, 'DB' is ambiguous and not explicitly defined.

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?

No guidance on when to use this tool versus alternatives, such as roiq_add_column. No prerequisites, when-not-to-use, or exclusions are provided.

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