Skip to main content
Glama

comments_list

List comments for a specific entity, such as a document, by providing the entity type and optional entity ID. Supports pagination for large comment sets.

Instructions

List comments for an entity (e.g. entityType: "document").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoNumber of results
offsetNoPagination offset
entityIdNoEntity ID
nextPathNoNext page path for pagination
entityTypeYesEntity type, e.g. "document"
Behavior2/5

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

With no annotations, the description must disclose behavioral traits on its own. It does not mention pagination behavior, return format, necessary permissions, or any side effects. The presence of pagination parameters (limit/offset/nextPath) is left unaddressed, leaving the agent under-informed.

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, well-structured sentence that front-loads the action and provides a useful example. It is appropriately concise with no redundant wording.

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?

This is a paginated list tool with no output schema, so the description needs to explain how to use parameters like entityId and pagination. It does not, and the example only shows entityType, which may mislead an agent into thinking entityId is optional. The lack of return value description further reduces completeness.

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%, so the baseline is 3. The description adds an example for entityType but does not clarify entityId or the pagination flow. The schema descriptions for each parameter are present but shallow, and the tool description does not compensate for these gaps.

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 ('List comments') and the resource ('for an entity'), with a concrete example for entityType. It distinguishes the basic purpose from create/update/delete/resolve siblings, but does not explicitly differentiate from comments_info or comments_thread, so it lacks full 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 alternatives like comments_thread or comments_info. The description only states what it does without providing context for choosing it over siblings or any exclusions.

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/NikitaMurugov/yonote-mcp'

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