superdoc_comment
Manage document comment threads: create, read, update, and delete. To create a comment, first use superdoc_search to find the target text, then pass action "create" with the comment text and a target built from items[0].blocks. For a single-block match use {kind:"text", blockId: items[0].blocks[0...
This record as markdown: /tools/superdoc-mcp/superdoc-comment.md
What superdoc_comment does on Superdoc
AI agents use superdoc_comment to create or update resources in Superdoc, usually the action step of a workflow, after the agent has gathered context. Every call changes real data in your Superdoc environment.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | — | Required for actions 'delete', 'get'. |
side | string | — | Optional side for the top-level trackedChangeId shorthand. Only for action 'create'. Omit for other actions. |
text | object | — | Comment text content. Required for action 'create'. |
force | boolean | — | Bypass confirmation checks. |
limit | integer | — | Maximum number of comments to return. Only for action 'list'. Omit for other actions. |
story | object | — | Optional story for the top-level trackedChangeId shorthand. Only for action 'create'. Omit for other actions. |
action | string | Yes | The action to perform. One of: create, delete, get, list, update. |
author | string | — | Author display name. Defaults to the configured session author. Only for action 'create'. Omit for other actions. |
offset | integer | — | Number of comments to skip for pagination. Only for action 'list'. Omit for other actions. |
status | string | — | Set comment status. Use 'resolved' to resolve a comment, or 'active' to reopen a previously resolved comment (lifecycle inverse). Only for action 'update'. Omit |
target | object | — | Text range to anchor the comment. Accepts either a single-block TextAddress {kind:'text', blockId, range}, a multi-segment TextTarget {kind:'text', segments:[{b |
authorId | string | — | Stable caller-owned author id. Only for action 'create'. Omit for other actions. |
Parameters from the server's own tool schema.
Why superdoc_comment is rated Medium
An AI agent can call superdoc_comment faster than any human can review: one bad instruction and it creates or modifies resources in Superdoc by the hundred, each call as confident as the last.
Risk signalsHigh parameter count (23 properties)
Attacks that exploit this kind of access
The rule that runs superdoc_comment safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Superdoc, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For superdoc_comment, this is the rule to start with:
superdoc_comment stays usable, but capped: an agent stuck in a loop can't make hundreds of changes a minute. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Superdoc, apply this rule, and every superdoc_comment call is checked against it from then on.
Questions about superdoc_comment
Manage document comment threads: create, read, update, and delete. To create a comment, first use superdoc_search to find the target text, then pass action "create" with the comment text and a target built from items[0].blocks. For a single-block match use {kind:"text", blockId: items[0].blocks[0].blockId, range: items[0].blocks[0].range}. For a cross-block match use {kind:"text", segments: items[0].blocks.map(b => ({blockId: b.blockId, range: b.range}))}. Do NOT use items[0].highlightRange (snippet-relative, not block-relative) or items[0].target (a SelectionTarget, not accepted by comments.create). For threaded replies, pass "parentId" with the parent comment ID. Action "list" returns all comments with optional pagination (limit, offset) and filtering (includeResolved:true to include resolved). Action "get" retrieves a single comment by ID. Action "update" changes comment text, re-anchors the thread, changes status to "resolved", or toggles the legacy sdcom:internal flag for v1 compatibility. Action "delete" removes a comment or reply by ID. Do NOT pass "ref", "id", or "parentId" when creating a new top-level comment; "action", "text", and "target" are required, while commentId (the v1 compatibility alias for externalId), externalId, author fields, and metadata are optional correlation fields. EXAMPLES: 1. {"action":"create","text":"Please review this section.","target":{"kind":"text","blockId":"<blockId>","range":{"start":5,"end":25}}} 2. {"action":"list","limit":20,"offset":0} 3. {"action":"update","id":"<commentId>","status":"resolved"} 4. {"action":"delete","id":"<commentId>"}. It is categorised as a Write tool in the Superdoc MCP Server, which means it can create or modify data. Consider rate limits to prevent runaway writes.
superdoc_comment accepts 12 parameters: id, side, text, force, limit, story, action, author, offset, status, target, authorId. Required: action. The full parameter table on this page comes from the server's own tool schema.
Register the Superdoc MCP server in PolicyLayer and add a rule for superdoc_comment: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Superdoc. Nothing to install.
superdoc_comment is a Write tool with medium risk. Write tools should be rate-limited to prevent accidental bulk modifications.
Yes. Add a rate_limit block to the superdoc_comment rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for superdoc_comment. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
superdoc_comment is provided by the Superdoc MCP server (@superdoc/mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Superdoc, and thousands of servers like it.
This server
Across the catalogue