Markdown by mdedit.ai

Add a review comment

add_comment

Idempotent

Add an anchored review comment without directly changing document prose. Accepts natural workspace names and document titles; internal routing identifiers are optional. Returns threadId and targetId for reply_to_thread and resolve_thread.

Input Schema

TableJSON Schema

Name	Required	Description
`body`	Yes
`anchor`	Yes
`context`	Yes	Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
`targetId`	No
`articleId`	No	Internal document identifier when already available. Omit it when the user referred to the document by title.
`commandId`	Yes	Globally unique UUID for this logical review mutation. Generate it once and reuse the exact value if the tool call is retried.
`workspaceId`	No	Optional workspace ID to narrow document lookup. Omit when the document title or ID uniquely identifies a document across authorized workspaces.
`articleTitle`	No	Human-visible document title. Prefer this over asking the user for an internal document identifier.
`workspaceName`	No	Optional workspace name to narrow document lookup. A unique document title can be used without a workspace choice.

Output Schema

TableJSON Schema

Name	Required	Description
`events`	Yes
`applied`	Yes
`targetId`	Yes	Review target containing the new thread. Pass this exact value with threadId to resolve_thread or reply_to_thread.
`threadId`	Yes	Stable review thread identifier. Pass this exact value with targetId to resolve_thread or reply_to_thread; do not use commandId.
`articleId`	Yes
`commandId`	Yes
`workspaceId`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedOct 10, 2026

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",
-  "body",
-  "commandId"
-]New value: +[
+  "anchor",
+  "body",
+  "commandId",
+  "context"
+]

Changed5 schema fields changedSep 15, 2026

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",
-  "body"
-]New value: +[
+  "anchor",
+  "body",
+  "commandId"
+]

First observedAug 28, 2026

TDQS

A4.2/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and idempotentHint=true, so the safety and retry profile is largely covered. The description's 'without directly changing document prose' is a useful clarification of mutation scope, but it partially restates destructiveHint=false, and adds no auth, rate-limit, or failure-mode detail.

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 sentences, front-loaded with the core action and scope, then the input flexibility, then the return contract. No filler or restated title.

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?

Output schema exists so return format need not be explained, yet the description still tells the agent which values to carry forward into follow-up calls, which is valuable chaining context for a 9-parameter tool. Minor gap: no note on anchor failure behavior or idempotent retry expectations beyond what commandId's schema text provides.

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?

With 67% schema coverage, the schema handles most parameter documentation, but the description adds real routing guidance the schema does not: it tells the agent that natural workspace names and document titles are acceptable and that internal routing identifiers are optional. It also flags the anchor/body requirement implicitly via 'anchored ... comment'.

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+resource ('Add an anchored review comment') and immediately scopes it ('without directly changing document prose'), which cleanly separates it from siblings like add_suggestion, edit_article, and save_article_content. An agent can route to it without opening any 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?

The description names the downstream tools (reply_to_thread, resolve_thread) that consume the returned threadId/targetId, giving clear workflow context for when this tool belongs in a sequence. It stops short of stating explicit exclusions, e.g. when to prefer add_suggestion over a comment.

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 tools Inspect

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

Need Help?