Skip to main content
Glama

Delete a document comment

delete_doc_comment
Destructive

Remove a comment from a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commentIdYesThe comment id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

The annotation destructiveHint: true already discloses the destructive nature, and the description ('Remove') is consistent with that. However, it adds no extra behavioral context such as permanence, cascade effects, or failure conditions. With annotations present, the bar is lower, but the description contributes nothing beyond the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence with no wasted words. It is front-loaded with the verb and clearly states the action. Ideal for quick parsing by an agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple delete operation with one parameter and destructive annotation, the description covers the core requirement. It lacks minor context like whether the user needs permission or if the comment must exist, but these are not critical for a tool of this simplicity. The output schema absence is acceptable for a delete operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema provides full description of the sole parameter commentId ('The comment id.'). The description adds no additional meaning or format details. Since schema coverage is 100%, the baseline of 3 is appropriate; the description does not enhance parameter understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Remove') and the resource ('a comment from a document'), which is distinct from the title. However, it does not differentiate from sibling tools like delete_comment, leaving the agent to infer the difference. The purpose is unambiguous but lacks sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus delete_comment or edit_doc_comment. No context is given about the intended scope (e.g., only document comments vs. issue comments) or any prerequisites. The agent must rely on the name alone to decide, which is insufficient.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.