Skip to main content
Glama

MarkupBase

by com.markupbase.mcp

add_comment

Idempotent

Create a new open review thread with its first comment, anchored to the whole artifact, exact text, or an HTML element in one immutable version. The caller needs comment access and comment creation is rate-limited. Use reply_to_thread for an existing discussion instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesInitial review comment for the new thread.
anchorNoLocation in the specified version; defaults to the whole artifact.
versionIdYesID of the exact immutable artifact version.
documentIdYesID of the artifact containing the target resource.
idempotencyKeyYesStable unique key for this intended change; reuse only to retry the same inputs.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
anchorYesLocation for a new thread: the whole artifact, exact text, or an HTML element.
statusYesCurrent review-thread state.
commentsYes
outdatedYes
createdAtYesISO 8601 timestamp.
documentIdYes
resolvedAtYes
resolvedByYes
resolvedByNameYes
statusUpdatedAtYes
statusUpdatedByYes
createdVersionIdYes
currentVersionIdYes
statusUpdatedByNameYes
resolvedOnBehalfOfIdYes
resolvedOnBehalfOfNameYes
statusUpdatedOnBehalfOfIdYes
statusUpdatedOnBehalfOfNameYes

Schema Changelog

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

  1. Changed7 schema fields changed
    • addedInput schema / properties / anchor / description
      Added value: +"Location in the specified version; defaults to the whole artifact."
    • changedInput schema / properties / anchor / oneOf
      Previous value: -[
-  {
-    "properties": {
-      "kind": {
-        "const": "document",
-        "type": "string"
-      }
-    },
-    "required": [
-      "kind"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "kind": {
-        "const": "text",
-        "type": "string"
-      },
-      "quote": {
-        "properties": {
-          "exact": {
-            "maxLength": 2000,
-            "minLength": 1,
-            "type": "string"
-          },
-          "prefix": {
-            "default": "",
-            "maxLength": 250,
-            "type": "string"
-          },
-          "suffix": {
-            "default": "",
-            "maxLength": 250,
-            "type": "string"
-          }
-        },
-        "required": [
-          "exact"
-        ],
-        "type": "object"
-      }
-    },
-    "required": [
-      "kind",
-      "quote"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "kind": {
-        "const": "element",
-        "type": "string"
-      },
-      "path": {
-        "maxLength": 2000,
-        "minLength": 1,
-        "type": "string"
-      },
-      "quote": {
-        "properties": {
-          "exact": {
-            "maxLength": 2000,
-            "minLength": 1,
-            "type": "string"
-          },
-          "prefix": {
-            "default": "",
-            "maxLength": 250,
-            "type": "string"
-          },
-          "suffix": {
-            "default": "",
-            "maxLength": 250,
-            "type": "string"
-          }
-        },
-        "required": [
-          "exact"
-        ],
-        "type": "object"
-      }
-    },
-    "required": [
-      "kind",
-      "path"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "kind": {
+        "const": "document",
+        "description": "Anchor the thread to the whole artifact.",
+        "type": "string"
+      }
+    },
+    "required": [
+      "kind"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "kind": {
+        "const": "text",
+        "description": "Anchor the thread to an exact text selection.",
+        "type": "string"
+      },
+      "quote": {
+        "description": "Text selection and optional surrounding context.",
+        "properties": {
+          "exact": {
+            "description": "Exact selected text in the referenced version.",
+            "maxLength": 2000,
+            "minLength": 1,
+            "type": "string"
+          },
+          "prefix": {
+            "default": "",
+            "description": "Optional text immediately before the selection.",
+            "maxLength": 250,
+            "type": "string"
+          },
+          "suffix": {
+            "default": "",
+            "description": "Optional text immediately after the selection.",
+            "maxLength": 250,
+            "type": "string"
+          }
+        },
+        "required": [
+          "exact"
+        ],
+        "type": "object"
+      }
+    },
+    "required": [
+      "kind",
+      "quote"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "kind": {
+        "const": "element",
+        "description": "Anchor the thread to an HTML element path.",
+        "type": "string"
+      },
+      "path": {
+        "description": "Stable DOM path for the referenced HTML element.",
+        "maxLength": 2000,
+        "minLength": 1,
+        "type": "string"
+      },
+      "quote": {
+        "description": "Optional text context used to carry the anchor forward.",
+        "properties": {
+          "exact": {
+            "description": "Exact selected text in the referenced version.",
+            "maxLength": 2000,
+            "minLength": 1,
+            "type": "string"
+          },
+          "prefix": {
+            "default": "",
+            "description": "Optional text immediately before the selection.",
+            "maxLength": 250,
+            "type": "string"
+          },
+          "suffix": {
+            "default": "",
+            "description": "Optional text immediately after the selection.",
+            "maxLength": 250,
+            "type": "string"
+          }
+        },
+        "required": [
+          "exact"
+        ],
+        "type": "object"
+      }
+    },
+    "required": [
+      "kind",
+      "path"
+    ],
+    "type": "object"
+  }
+]
    • addedInput schema / properties / body / description
      Added value: +"Initial review comment for the new thread."
    • addedInput schema / properties / documentId / description
      Added value: +"ID of the artifact containing the target resource."
    • addedInput schema / properties / idempotencyKey / description
      Added value: +"Stable unique key for this intended change; reuse only to retry the same inputs."
    • addedInput schema / properties / versionId / description
      Added value: +"ID of the exact immutable artifact version."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "description": "Preserved review thread with its replies and status.",
+  "properties": {
+    "anchor": {
+      "description": "Location for a new thread: the whole artifact, exact text, or an HTML element.",
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "kind": {
+              "const": "document",
+              "description": "Anchor the thread to the whole artifact.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "kind"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "kind": {
+              "const": "text",
+              "description": "Anchor the thread to an exact text selection.",
+              "type": "string"
+            },
+            "quote": {
+              "additionalProperties": false,
+              "description": "Text selection and optional surrounding context.",
+              "properties": {
+                "exact": {
+                  "description": "Exact selected text in the referenced version.",
+                  "maxLength": 2000,
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "prefix": {
+                  "default": "",
+                  "description": "Optional text immediately before the selection.",
+                  "maxLength": 250,
+                  "type": "string"
+                },
+                "suffix": {
+                  "default": "",
+                  "description": "Optional text immediately after the selection.",
+                  "maxLength": 250,
+                  "type": "string"
+                }
+              },
+              "required": [
+                "exact",
+                "prefix",
+                "suffix"
+              ],
+              "type": "object"
+            }
+          },
+          "required": [
+            "kind",
+            "quote"
+          ],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "kind": {
+              "const": "element",
+              "description": "Anchor the thread to an HTML element path.",
+              "type": "string"
+            },
+            "path": {
+              "description": "Stable DOM path for the referenced HTML element.",
+              "maxLength": 2000,
+              "minLength": 1,
+              "type": "string"
+            },
+            "quote": {
+              "additionalProperties": false,
+              "description": "Optional text context used to carry the anchor forward.",
+              "properties": {
+                "exact": {
+                  "description": "Exact selected text in the referenced version.",
+                  "maxLength": 2000,
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "prefix": {
+                  "default": "",
+                  "description": "Optional text immediately before the selection.",
+                  "maxLength": 250,
+                  "type": "string"
+                },
+                "suffix": {
+                  "default": "",
+                  "description": "Optional text immediately after the selection.",
+                  "maxLength": 250,
+                  "type": "string"
+                }
+              },
+              "required": [
+                "exact",
+                "prefix",
+                "suffix"
+              ],
+              "type": "object"
+            }
+          },
+          "required": [
+            "kind",
+            "path"
+          ],
+          "type": "object"
+        }
+      ]
+    },
+    "comments": {
+      "items": {
+        "additionalProperties": false,
+        "description": "One saved review comment.",
+        "properties": {
+          "authorId": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "authorName": {
+            "type": "string"
+          },
+          "authorOnBehalfOfId": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "authorOnBehalfOfName": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "body": {
+            "type": "string"
+          },
+          "createdAt": {
+            "description": "ISO 8601 timestamp.",
+            "type": "string"
+          },
+          "editedAt": {
+            "anyOf": [
+              {
+                "description": "ISO 8601 timestamp.",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "id": {
+            "format": "uuid",
+            "pattern": "^([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)$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "authorId",
+          "authorName",
+          "authorOnBehalfOfId",
+          "authorOnBehalfOfName",
+          "body",
+          "createdAt",
+          "editedAt",
+          "id"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "createdAt": {
+      "description": "ISO 8601 timestamp.",
+      "type": "string"
+    },
+    "createdVersionId": {
+      "format": "uuid",
+      "pattern": "^([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)$",
+      "type": "string"
+    },
+    "currentVersionId": {
+      "format": "uuid",
+      "pattern": "^([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)$",
+      "type": "string"
+    },
+    "documentId": {
+      "format": "uuid",
+      "pattern": "^([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)$",
+      "type": "string"
+    },
+    "id": {
+      "format": "uuid",
+      "pattern": "^([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)$",
+      "type": "string"
+    },
+    "outdated": {
+      "type": "boolean"
+    },
+    "resolvedAt": {
+      "anyOf": [
+        {
+          "description": "ISO 8601 timestamp.",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "resolvedBy": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "resolvedByName": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "resolvedOnBehalfOfId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "resolvedOnBehalfOfName": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "status": {
+      "description": "Current review-thread state.",
+      "enum": [
+        "open",
+        "resolved"
+      ],
+      "type": "string"
+    },
+    "statusUpdatedAt": {
+      "anyOf": [
+        {
+          "description": "ISO 8601 timestamp.",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "statusUpdatedBy": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "statusUpdatedByName": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "statusUpdatedOnBehalfOfId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "statusUpdatedOnBehalfOfName": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "anchor",
+    "comments",
+    "createdAt",
+    "createdVersionId",
+    "currentVersionId",
+    "documentId",
+    "id",
+    "outdated",
+    "resolvedAt",
+    "resolvedBy",
+    "resolvedByName",
+    "resolvedOnBehalfOfId",
+    "resolvedOnBehalfOfName",
+    "status",
+    "statusUpdatedAt",
+    "statusUpdatedBy",
+    "statusUpdatedByName",
+    "statusUpdatedOnBehalfOfId",
+    "statusUpdatedOnBehalfOfName"
+  ],
+  "type": "object"
+}
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already cover readOnlyHint=false, destructiveHint=false, idempotentHint=true. The description adds genuinely useful behavioral context: the caller must have comment access and creation is rate-limited. It clarifies that the thread is open and anchored to an immutable version. This goes beyond annotations without contradicting them.

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 only two sentences, with the core purpose front-loaded in the first sentence and usage guidance in the second. Every phrase earns its place—no fluff, no redundancy with schema.

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 tool's moderate complexity, the description covers purpose, usage context, permissions, and rate limits. The schema and annotations handle parameter details and safety semantics, and an output schema is present, so no return-value explanation is needed. It feels complete for an agent to select and call correctly.

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% with descriptive parameter details, so the baseline is 3. The description's mention of anchoring options (whole artifact, exact text, HTML element) summarizes what the schema already documents in detail via const values and descriptions. It does not add new semantic meaning beyond the schema.

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 a specific verb and resource: 'Create a new open review thread with its first comment', and specifies anchoring options (whole artifact, exact text, HTML element) and immutable version. It distinguishes itself from the sibling tool reply_to_thread by explicitly directing existing discussions there.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance: use for creating a new thread, and 'Use reply_to_thread for an existing discussion instead' names the alternative. It also adds context about caller permissions ('needs comment access') and rate limiting, helping the agent decide when to invoke.

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

All MarkupBase toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool targets a distinct action: comment creation vs. reply, review request vs. completion, thread status vs. comment, document read vs. list. No two tools have overlapping responsibilities, and descriptions clarify precise usage.

Naming Consistency5/5

All tools follow a consistent verb_noun snake_case pattern (add_comment, complete_review, create_document, get_document, list_documents, list_review_inbox, list_threads, publish_version, reply_to_thread, request_review, set_thread_status). whoami deviates slightly but is a standard, recognizable exception.

Tool Count5/5

12 tools is well within the optimal 3-15 range and appropriately covers the document/review/thread domain without bloat or excessive abstraction. Each tool serves a clear purpose in the workflow.

Completeness4/5

Core lifecycle is covered: document creation/reading/versioning, review request/completion/inbox, and thread create/reply/status. Minor gaps exist, such as no explicit document deletion or metadata update, but these do not hinder primary review workflows.

Resources