Skip to main content
Glama

Add a review suggestion

add_suggestion

Add an anchored replacement suggestion for a human to accept or reject. Accepts natural workspace names and document titles; internal routing identifiers are optional. Returns suggestionId and targetId for accept_suggestion or reject_suggestion.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo
anchorYes
replaceYes
targetIdNo
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
commandIdNo
workspaceIdNoInternal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
workspaceNameNoHuman-visible workspace name. Prefer this over asking the user for an internal workspace identifier.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
eventsYes
appliedYes
targetIdYesReview target containing the suggestion. Pass this exact value with suggestionId to accept_suggestion or reject_suggestion.
articleIdYes
commandIdYes
workspaceIdYes
suggestionIdYesStable suggestion identifier. Pass this exact value with targetId to accept_suggestion or reject_suggestion.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

The description adds workflow behavior beyond the annotations: the suggestion is a proposal for a human to accept or reject, it returns identifiers for downstream tools, and internal routing IDs are optional/resolvable from natural names. The annotations already communicate non-read-only and non-idempotent characteristics, so the description's added workflow context is valuable. No contradiction with annotations.

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?

Three tight sentences with no filler. The main action is front-loaded, followed by parameter routing guidance and then the return-value tie-in. Every sentence adds useful information for selecting or invoking the tool.

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?

Given the complex 9-parameter schema and the presence of an output schema, the description covers the essential selection and invocation context: what the tool does, how to reference workspaces/documents naturally, and how the returned IDs connect to accept_suggestion and reject_suggestion. It could add explicit sibling exclusions or anchor-selection tips, but no major ambiguity remains.

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?

The description usefully explains that natural workspace names and document titles are accepted and that internal routing identifiers are optional, which helps with several parameters. However, it does not explain the two anchor forms (quote-based vs range-based), the occurrence/context fields, or how to choose between them, so the low schema description coverage is only partially compensated.

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 opens with a specific verb and resource: 'Add an anchored replacement suggestion for a human to accept or reject.' The 'anchored' and 'replacement' qualifiers clearly distinguish it from add_comment, and the human accept/reject framing distinguishes it from direct document editing tools.

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?

The description clearly situates this tool in a review workflow by stating it returns suggestionId and targetId 'for accept_suggestion or reject_suggestion.' It also gives practical guidance about using natural workspace names and document titles instead of internal IDs. It does not explicitly enumerate when-not cases like add_comment, but the context is clear and not misleading.

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.

TDQS

A3.6/5.0
Disambiguation4/5

Most tools have clearly distinct purposes across article CRUD, review workflows, publishing, and conversion/export. Minor confusion can arise between convert_document and start_article_export (and their corresponding status checkers), but the descriptions explicitly differentiate arbitrary content conversion from exporting stored documents. The render_article tool's broad contextual wording overlaps conceptually with several actions, though its actual function (opening the reader) is unique.

Naming Consistency5/5

All 22 tool names follow a strict snake_case verb_noun pattern, such as list_articles, accept_suggestion, start_article_export, and unpublish_article. There are no mixed conventions, vague verbs, or camelCase outliers, making the naming highly predictable.

Tool Count3/5

At 22 tools, the server sits above the ideal 3-15 range and feels somewhat heavy for an MCP surface. The inclusion of record_article_app_event, a component-only telemetry tool with no agent-facing value, adds to this heaviness. However, the breadth of the domain—documents, collaboration, publishing, and conversion—largely justifies the count.

Completeness3/5

The tool surface covers article lifecycle, review threads, publishing, export/conversion, and presence well, covering most common workflows. A notable gap is the lack of any delete_article or trash operation, leaving no way to remove documents. Additionally, updates are limited to anchored edits via edit_article, with no direct full-content replacement option.

Resources