Update asset comment
update_asset_commentUpdate an existing asset comment by ID. Requires asset_comments:write scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Asset comment ID | |
| comment | No | Comment text |
update_asset_commentUpdate an existing asset comment by ID. Requires asset_comments:write scope.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Asset comment ID | |
| comment | No | Comment text |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=true and readOnlyHint=false, so the safety profile is covered. The description adds a genuinely useful prerequisite (asset_comments:write scope), but does not explain partial vs full replacement semantics or why an update is flagged destructive.
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 short sentences with zero waste; the core action is front-loaded and the permission requirement follows. Nothing is padded or repeated.
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?
For a simple two-parameter update tool with full schema coverage and annotations covering safety, the description is nearly complete. The only minor gap is the absence of any statement about the effect of omitting the optional 'comment' field, which there is no output schema to compensate for.
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 description coverage is 100%, so 'id' and 'comment' are already documented in the schema. The description adds no syntax, format, or constraint detail beyond what the schema provides, which is the expected baseline when the schema does the heavy lifting.
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?
States a specific verb and resource ('Update an existing asset comment by ID'), which is enough to distinguish it from the many create_/delete_/get_ siblings. It does not, however, explicitly differentiate it from near-identical siblings like update_infrastructure_asset_comment or update_project_comment.
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 gives no when-to-use guidance, no mention of alternatives, and no preconditions beyond the scope requirement. An agent must infer from the name alone that this targets asset comments rather than infrastructure-asset or project comments.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.