weeek_set_task_mr_link

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

No annotations provided, so description carries full burden. It discloses that this is a write operation and may prompt for confirmation, explains it only writes to existing fields, and lists required parameters. Does not mention overwrite behavior, but 'write' implies replacement.

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?

Concise, front-loaded with purpose and write warning. Follows with required/optional parameters, usage context, and alternatives. Every sentence adds value; 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?

Given no output schema, description is fully complete for this simple write tool. Covers purpose, when to use, parameter details, prerequisites, and alternatives. No gaps.

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%. Description adds meaning: mr_url is the URL to store, task_id must be obtained from weeek_list_tasks, field_name defaults to 'МР', must match exactly (case-insensitive), and that the tool does not create the field. This goes beyond 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?

Clearly states the action: attaching a merge/pull request URL to a WEEEK task by writing into a specific custom field. Distinguishes from sibling tools like weeek_move_task and weeek_complete_task by noting they can record the MR link simultaneously with a status change.

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 explicit usage: 'Call this right after opening an MR/PR for a task.' Gives clear alternatives for simultaneous status changes and warns that the custom field must already exist. Includes prerequisites and source for task_id.

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