bitrix24_crm_timeline_comment_list

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

No annotations given, description carries full burden. It implies a read operation and lists return fields, but omits details like pagination, rate limits, or authentication requirements.

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, front-loaded with purpose, no fluff.

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?

No output schema but description gives return fields. Adequate for a list tool, though missing details on default limit behavior or ordering.

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 covers all 4 parameters with descriptions (100% coverage). Description adds no extra meaning to parameters, so baseline 3 applies.

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 it lists manual timeline comments (manager notes) on CRM entities, distinguishes from activities and structured fields, and specifies return fields (COMMENT, AUTHOR_ID, CREATED).

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?

Mentioned usefulness for reviewing manager notes beyond structured fields, but lacks explicit when-not-to-use or comparison with sibling tools like activity list or note get.

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