Skip to main content
Glama

list_document_comments

Read-onlyIdempotent

Retrieve comments on a document with pagination to review feedback and discussions from users. Optionally include the text that comments refer to.

Instructions

    Retrieves comments on a specific document with pagination support.

    IMPORTANT: By default, this returns up to 25 comments at a time. If
    there are more than 25 comments on the document, you'll need to make
    multiple calls with different offset values to get all comments. The
    response will indicate if there
    are more comments available.

    Use this tool when you need to:
    - Review feedback and discussions on a document
    - See all comments from different users
    - Find specific comments or questions
    - Track collaboration and input on documents

    Args:
        document_id: The document ID to get comments from
        include_anchor_text: Whether to include the document text that
            comments refer to
        limit: Maximum number of comments to return (default: 25)
        offset: Number of comments to skip for pagination (default: 0)

    Returns:
        Formatted string containing comments with author, date, and
        optional anchor text
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
document_idYes
include_anchor_textNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true. Description adds value by explaining pagination details (default 25 comments, need multiple calls) and that response indicates more comments available. No contradictions.

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

Conciseness4/5

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

Well-structured with sections (IMPORTANT, use cases, args, returns). Slightly verbose but each sentence adds value. No clutter.

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

Completeness5/5

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

Given 4 parameters, no enums, and existence of output schema, the description covers pagination, return format (formatted string with author, date, anchor text), and use cases. Annotations cover safety. Complete for a read-only tool.

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

Parameters5/5

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

Input schema has 0% description coverage, but the description compensates by explaining all four parameters: document_id, include_anchor_text, limit, offset, including defaults and purpose. Fully compensates for lack of schema descriptions.

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?

Clearly states it retrieves comments on a document with pagination support. Uses specific verb 'retrieves' and resource 'comments', distinguishing from siblings like 'get_comment' (singular) and 'add_comment' (create).

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

Usage Guidelines4/5

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

Provides explicit use cases: review feedback, see all comments, find specific comments, track collaboration. Mentions pagination behavior and need for multiple calls. However, does not explicitly contrast with alternatives or state when not to use.

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/Vortiago/mcp-outline'

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