Skip to main content
Glama

Markdown by mdedit.ai

by io.github.mangoappstudio
OverviewDiscussionsAdmin

Add a review suggestion

add_suggestion
Idempotent

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
contextYesDescribe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
replaceYes
targetIdNo
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
commandIdYesGlobally unique UUID for this logical review mutation. Generate it once and reuse the exact value if the tool call is retried.
workspaceIdNoOptional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
workspaceNameNoOptional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.

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.

  1. Changed5 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
+  "description": "Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.",
+  "type": "string"
+}
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace."New value: +"Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces."
    • changedInput schema / properties / workspaceName / description
      Previous value: -"Human-visible workspace name. Prefer this over asking the user for an internal workspace identifier."New value: +"Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice."
    • changedInput schema / required
      Previous value: -[
-  "anchor",
-  "replace",
-  "commandId"
-]New value: +[
+  "anchor",
+  "replace",
+  "commandId",
+  "context"
+]
  2. Changed5 schema fields changed
    • addedInput schema / properties / commandId / description
      Added value: +"Globally unique UUID for this logical review mutation. Generate it once and reuse the exact value if the tool call is retried."
    • addedInput schema / properties / commandId / format
      Added value: +"uuid"
    • removedInput schema / properties / commandId / minLength
      Removed value: -1
    • addedInput schema / properties / commandId / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • changedInput schema / required
      Previous value: -[
-  "anchor",
-  "replace"
-]New value: +[
+  "anchor",
+  "replace",
+  "commandId"
+]
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds genuinely new behavior: the suggestion is a pending proposal awaiting human accept/reject, and the response yields the two IDs needed to act on it. It adds no permission or failure-mode detail, so it is not a 5.

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, front-loaded with what the tool creates and followed by input conventions and return values. No filler or repetition of schema mechanics.

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?

For a 10-parameter mutation with an output schema, the description covers the important ground: artifact type, human-review workflow, flexible identifier input, and follow-up IDs. The main gap is that the anchor forms and the note field remain unexplained outside the schema.

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

Parameters4/5

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

Schema description coverage is only 60%, so the description must compensate, and it does for the routing parameters: it says natural workspace names/document titles are accepted and internal identifiers are optional, which clarifies articleTitle/workspaceName vs articleId/workspaceId/targetId. It does not explain the anchor's quote-vs-range alternatives or the note/replace fields.

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?

States a specific verb (Add) and resource (an anchored replacement suggestion) plus the essential qualifier that a human must accept or reject it, which separates it from a direct edit_article or add_comment. It also names the downstream siblings (accept_suggestion/reject_suggestion), so an agent can place it in the review workflow 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?

Makes the workflow context explicit by stating the returned suggestionId/targetId are consumed by accept_suggestion or reject_suggestion, and tells the agent that natural workspace names and document titles are acceptable so it need not interrogate the user for internal IDs. It stops short of an explicit when-not-to-use rule versus add_comment or edit_article.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Markdown by mdedit.ai toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources