Skip to main content
Glama
delano
by delano

delete_api_comment

Delete a specific comment from a Postman API by providing the API ID and comment ID.

Instructions

Delete an API comment

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiIdYesAPI ID
commentIdYesComment ID

Implementation Reference

  • The handler function that executes the delete_api_comment tool logic. Validates apiId and commentId are present, then makes a DELETE request to /apis/{apiId}/comments/{commentId}.
    async deleteApiComment(args: any): Promise<ToolCallResponse> {
      if (!args.apiId || !args.commentId) {
        throw new McpError(ErrorCode.InvalidParams, 'apiId and commentId are required');
      }
      await this.client.delete(`/apis/${args.apiId}/comments/${args.commentId}`);
      return this.createResponse({ message: 'Comment deleted successfully' });
    }
  • Schema definition for the delete_api_comment tool, specifying input parameters: apiId (string, required) and commentId (number, required).
    {
      name: 'delete_api_comment',
      description: 'Delete an API comment',
      inputSchema: {
        type: 'object',
        properties: {
          apiId: {
            type: 'string',
            description: 'API ID',
          },
          commentId: {
            type: 'number',
            description: 'Comment ID',
          },
        },
        required: ['apiId', 'commentId'],
      },
    },
  • Tool dispatch registration in the handleToolCall switch statement, mapping the 'delete_api_comment' name to the deleteApiComment method.
    case 'delete_api_comment':
      return await this.deleteApiComment(args);
Behavior2/5

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

With no annotations, the description must fully disclose behavior. It only states the action (delete) but omits details like permanence, side effects, authorization needs, or return value.

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

Conciseness3/5

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

Extremely concise (4 words) but under-specified; lacks structure or additional explanatory sentences that would aid an AI agent.

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

Completeness2/5

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

Given no output schema, the description should explain return values or success indicators. It does not. Also lacks mention of idempotency or error conditions.

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?

Schema coverage is 100% with clear descriptions for both parameters. The description adds no additional parameter meaning, so baseline 3 applies.

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

Purpose2/5

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

Description merely restates the tool name ('Delete an API comment') with no additional context about what an API comment is or how it differs from other deletion tools. It is a tautology.

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?

No guidance on when to use this tool versus other deletion tools (e.g., delete_api, delete_api_version). No prerequisites or contextual cues provided.

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/delano/postman-mcp-server'

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