Skip to main content
Glama

List Document Suggestions

list_document_suggestions
Read-onlyIdempotent

List the suggestions sent for a document you own or can edit, with their status (pending, accepted, rejected, or out of date) and the reason given. Each pending one also has a review_url, the text before and after (or, for an HTML page layout change, what it changes in sentences), whether it still fits the document, and which other suggestions accepting it would make out of date. For comments and the suggestions that answer them, use list_comment_threads. Read-only.

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": {
      "slug": "<slug>"
    },
    "name": "list_document_suggestions"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesThe slug of the document
limitNoHow many to return (1 to 50). Default 20.
statusNoOnly suggestions with this status.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the closing "Read-only." is mostly redundant. What the description does add is substantial behavioral context beyond the annotations: the full return shape (review_url, before/after, fit indicator, and which suggestions accepting one would invalidate). Minor weakness: it never mentions serialization limits or pagination despite a 50-item cap.

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?

Front-loaded with the core action, then the return payload, then the sibling hand-off — a logical order with no filler sentences. The trailing "Read-only." duplicates the readOnlyHint annotation and is the one dispensable phrase.

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?

There is no output schema, and the description compensates fully by enumerating the fields each suggestion carries, including the conditional HTML-layout case. Combined with a fully documented schema, an agent has everything needed to call and interpret this tool, with only the omitted `withdrawn` status as a minor gap.

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% and the schema already documents `slug`, `limit` (1–50, default 20), and the `status` enum, so the baseline is 3. The description explains the meaning of the statuses but only lists four (pending, accepted, rejected, out of date) against an enum that also includes `withdrawn` and `stale`, leaving a small ambiguity about how those values relate to "out of date."

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?

Opens with a specific verb and resource ("List the suggestions sent for a document") and immediately narrows the scope to documents the caller owns or can edit. The enumerated statuses and the per-suggestion payload details let an agent tell this apart from adjacent list tools without opening the schema.

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?

Explicitly redirects to `list_comment_threads` for comments and the suggestions that answer them, which is a genuine alternative-selection rule. It lacks a stated when/when-not framing for the tool itself (e.g. reviewing pending suggestions before publishing), so it falls short of a full 5.

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.