Skip to main content
Glama

Get comment

get_comment
Read-onlyIdempotent

Open one comment with its author and the document it is on. Comments on public documents are public.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "commentId": "<commentId>"
    },
    "name": "get_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
commentIdYesComment id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare the operation read-only, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds useful access context ('Comments on public documents are public') and says the result includes author and document, but it does not clarify private-comment access, authentication requirements, or error behavior.

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 two short sentences with no wasted text. The core action and return content are front-loaded, and the access note follows naturally.

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 single-resource read with full schema coverage and rich annotations, the description is nearly complete: it says what is returned and notes public-comment visibility. A minor gap remains around how private comments behave or where comment IDs come from, but nothing essential to invocation is missing.

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 description coverage is 100%, and the single parameter commentId is already documented in the schema. The description adds no format, source, or constraint details beyond what the schema provides, so the baseline score of 3 applies.

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 states a specific verb and resource: 'Open one comment', and clarifies that the result includes the author and the document it belongs to. It distinguishes single-comment retrieval from list-oriented siblings implicitly via 'one comment', but it does not explicitly name or contrast with alternatives such as list_my_comments.

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?

The description implies retrieval of a single comment, but it gives no explicit guidance on when to use this tool versus list_my_comments or other comment-related tools. The note about public documents is access context, not usage guidance.

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.

Resources