get_work_package_activities

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

With no annotations, the description carries the full burden. It reveals the return order (most recent first), comment truncation behavior, and the existence of fields like comment_truncated and comment_length. This is good, but it does not explicitly state read-only nature or other potential side effects.

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, front-loaded with the purpose, and each sentence provides necessary detail without fluff. It efficiently covers key points in a few lines.

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 no output schema, the description should provide more detail about the response structure (e.g., fields in each activity entry). It only mentions comment-related indicators. Additionally, the 'limit' parameter is undocumented. The description is incomplete for a tool with 3 parameters and no schema descriptions.

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?

Despite 0% schema description coverage, the description explains two of three parameters: work_package_id (accepted formats) and text_limit (function and behavior). The 'limit' parameter is entirely missing from the description, so the agent gets incomplete parameter guidance.

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 'Get the activity log for a work package, most recent first.' It uses a specific verb and resource, and the purpose is distinct from sibling tools like get_work_package or list_work_package_activities (which doesn't exist). The ordering is explicitly mentioned.

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 explains the work_package_id format and text_limit usage but does not provide explicit guidance on when to use this tool versus alternatives, nor does it mention prerequisites or exclusions. Usage is implied but not fully defined.

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