Skip to main content
Glama

get_comments

List comments anchored in DOCX documents, showing author, body, element ID, and quoted range. Returns empty for Markdown files.

Instructions

List comments anchored in the document (native DOCX comments).

Each comment carries id, author, body, element_id and quoted range. For Markdown (which has no comment concept) the list is empty.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
doc_hashNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

Since no annotations are provided, the description carries the full burden of disclosing behavior. It does state that the tool handles native DOCX comments and returns empty for Markdown, which is useful behavioral context. However, it does not mention whether the operation is read-only, if it requires specific permissions, or any side effects. For a listing operation, the read-only nature is implied but not explicitly declared.

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 concise and front-loaded: it states the core purpose immediately, then provides additional detail on comment fields and the Markdown caveat in just two short paragraphs. Every sentence adds value with no fluff.

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?

While an output schema exists (so return structure is covered), the description fails to clarify the essential parameters, which are also undocumented. Additionally, there is no guidance on how to identify the document (path vs. hash) or any prerequisites. For a tool with two parameters and no annotation support, this is insufficient for confident invocation.

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

Parameters1/5

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

The schema has 0% description coverage, meaning the parameters 'path' and 'doc_hash' are not explained in the schema. The description also does not explain these parameters at all. It lacks any semantics regarding what 'path' refers to (file path? document ID?) or how 'doc_hash' is used. This is a critical gap for agent correctness.

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 operation ('List comments') and the resource ('anchored in the document'), with a precise qualifier ('native DOCX comments'). It distinguishes this from other tools by noting Markdown returns an empty list, which prevents ambiguity with sibling tools like get_changes or get_outline.

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 provides no explicit 'when to use' guidance or comparison with alternatives. It only mentions that Markdown yields an empty list, which is more of a behavioral caveat than usage direction. Without mention of siblings like get_changes or read_document, an agent may not know when this tool is appropriate.

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/xyyyang97/doc-agent-mcp'

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