上传 TAPD 缺陷描述内嵌图片

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

With no annotations provided, the description carries full burden. It discloses supported image types, single file ≤5MB, no modification to description, and returns html_code. It does not mention rate limits or authentication needs, but these are implied. The description provides adequate transparency for a straightforward upload tool.

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 extremely concise: two sentences that cover purpose, constraints, and usage flow. No redundant information. Every sentence earns its place.

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 absence of annotations and output schema, the description is fairly complete. It covers purpose, parameter details, return value (html_code), and the required subsequent steps to complete the bug description update. It could mention potential limitations like rate limits, but overall it provides sufficient context for an agent to use the tool correctly.

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%, so baseline is 3. The description adds value by clarifying that file_base64 can include or omit the data:URI prefix, confirmed must be true, filename must have an appropriate suffix, and workspace_id can be obtained from other tools. This goes beyond the schema definitions.

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 uploads an image to TAPD and returns an HTML img fragment for embedding in bug descriptions. It specifies supported formats and size limits, and distinguishes from the sibling tool tapd_append_bug_description_image that performs the full workflow.

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?

Explicitly explains when to use this tool: it only uploads the image, does not modify the description. It tells the agent to manually fetch the description, concatenate the html_code, and write back using tapd_writeback, or alternatively use tapd_append_bug_description_image for a one-step process. This provides clear context vs alternatives.

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