add_issue_note

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the tool creates ('新增') notes and can record time, implying a write/mutation operation. However, it doesn't disclose critical behavioral traits: whether this requires specific permissions, what happens on failure, if notes are editable/deletable, rate limits, or authentication needs. The return is vaguely described as '新增結果訊息' (add result message) without format details.

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 well-structured and appropriately sized. It starts with a clear purpose statement, then lists all parameters with helpful explanations, and ends with return information. Every sentence earns its place, though the return statement could be more specific. The bilingual nature (Chinese purpose, mixed parameter labels) is slightly inconsistent but functional.

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's complexity (7 parameters, mutation operation) and lack of annotations/output schema, the description is partially complete. It excels at parameter semantics but lacks behavioral context (permissions, errors, etc.) and detailed return format. For a write tool with no structured safety hints, more disclosure about side effects and response structure would be beneficial.

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?

The description adds significant semantic value beyond the input schema, which has 0% description coverage. It explains all 7 parameters in Chinese with clarifications: 'issue_id: 議題 ID' (issue ID), 'notes: 備註內容' (note content), 'private: 是否為私有備註（預設否）' (whether private note, default no), 'spent_hours: 耗用工時（小時）' (hours spent), 'activity_name: 活動名稱（與 activity_id 二選一）' (activity name, choose one with activity_id), 'activity_id: 活動 ID（與 activity_name 二選一）' (activity ID, choose one with activity_name), 'spent_on: 記錄日期 YYYY-MM-DD 格式（可選，預設今日）' (record date YYYY-MM-DD format, optional, default today). This fully compensates for the schema's lack of 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?

The description clearly states the tool's purpose: '為議題新增備註，可同時記錄時間' (Add notes to an issue, can also record time). It specifies the verb ('新增備註' - add notes) and resource ('議題' - issue), and mentions the additional time-tracking capability. However, it doesn't explicitly differentiate from sibling tools like 'update_issue_content' which might also modify issues.

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools like 'update_issue_content' or 'close_issue', nor does it specify prerequisites, constraints, or appropriate contexts for use. The agent must infer usage from the purpose alone.

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