Skip to main content
Glama

delete_comment

Delete a comment permanently from GitBook by providing space ID and comment ID. This action cannot be undone.

Instructions

Delete a comment (DESTRUCTIVE: cannot be undone)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesThe ID of the space
commentIdYesThe ID of the comment to delete
changeRequestIdNoOptional change request ID if comment is on a CR
Behavior4/5

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

With no annotations provided, the description carries the transparency burden. It discloses the critical behavioral trait that deletion is destructive and cannot be undone, which is essential for an agent to assess risk. It does not go further (e.g., permissions), but for a simple delete tool, this is a solid disclosure.

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, impactful sentence that front-loads the action and the critical risk. Every word earns its place; there is no fluff or redundancy.

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?

Given the simplicity of the tool (no output schema, straightforward parameters), the description is complete enough for an agent to understand its purpose and primary risk. The sibling list provides surrounding context, and the destructive warning covers the main concern.

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 input schema covers all parameters with clear descriptions (100% coverage), so the description need not repeat them. It does not add any extra meaning beyond what the schema already provides, so a baseline score of 3 is appropriate.

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

Purpose5/5

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

The description clearly states the action ('Delete') and the resource ('a comment'), distinguishing it from siblings like post_comment and update_comment. The destructive warning adds necessary emphasis without obscuring the core purpose.

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

Usage Guidelines3/5

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

The description implies usage for removing comments but does not explicitly state when to choose this over alternatives or mention any prerequises. No exclusions or when-not-to-use guidance is provided beyond the destructive warning.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lucasbenevinuto/gitbook-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server