Add Compose document comment

Outcome

Persist a comment and unique mentions on an accessible document, then attempt platform notifications. A successful response proves saved comment metadata, not delivery.

Before you start

• Verify the authenticated identity, environment and pinned organization before preparing an action.
• The published application permission is workspace:write. Discover and select a granted Compose workspace separately from action input. A supplied identifier does not grant access.
• A read_write workspace grant is required, including model suggestion previews that do not persist document text.
• Authorize the documented effects or private-data export before CLI --confirm or MCP confirm:true. HTTP method alone does not establish a read-only operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_compose.documents.comments.create --detail --json
topolo resources topolo-compose --json
topolo workspaces list topolo-compose --json

• Select the granted workspace id as COMPOSE_WORKSPACE_ID. Use document and version ids returned by accessible reads; fixture ids confer no live access.

Request

POST /api/documents/{documentId}/comments

Save action input as payload.json. Inspect the plan for the exact path, query and body. Set COMPOSE_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console, then perform the verification below.

Input fields

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "minLength": 1
    },
    "body": {
      "type": "string",
      "minLength": 1
    },
    "mentionedUserIds": {
      "default": [],
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    }
  },
  "required": [
    "documentId",
    "body",
    "mentionedUserIds"
  ],
  "additionalProperties": false
}

Effects

• Creates a comment record and unique non-author mention records.
• Attempts Notify emission for mentioned users after persistence; notification failures do not roll back the comment.
• Does not alter document approval state or confer access to a mentioned person.

Interpret the response

Use response path $.comment.id for compose_comment. An empty list does not discover a target.

Expect HTTP 201 with comment.id and the deduplicated mentionedUserIds. Retain the comment id and request evidence. Compose has no published comment-read or comment-delete action; authorized organization export can inspect saved rows.

The success schema below was checked against captured handler responses. Optional structured generation metadata and integration-dependent values can vary. Error examples retain their actual refusal shapes.

Success schema:

{
  "type": "object",
  "required": [
    "comment"
  ],
  "properties": {
    "comment": {
      "type": "object",
      "required": [
        "id",
        "mentionedUserIds",
        "createdAt"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "mentionedUserIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "createdAt": {
          "type": "string"
        }
      }
    }
  }
}

Worked examples

Responses were captured from the actual Compose Worker using synthetic users, organizations, content and identifiers. Tests simulate Auth, Nexus, Notify, metering and platform workspace transport and use an in-memory D1 adapter or local SQLite. They prove local handler behavior, not live model correctness, provider cost, notification delivery, real workspace grants or cross-store atomicity. HTTP 204 responses are exactly empty strings in the SDK transport. Replace fixture identifiers through credential-scoped discovery. Refused examples demonstrate boundaries and must not be executed as successful workflows.

Successful request

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: Compose notification workflows > persists a comment and its unique non-author mentions before emitting.

Input · payload.json:

{
  "documentId": "149c1faf-3b05-4194-930a-04d2022ff964",
  "body": "Please confirm the evidence.",
  "mentionedUserIds": [
    "user_reviewer",
    "user_test_1",
    "user_reviewer"
  ]
}

CLI:

topolo actions validate app_topolo_compose.documents.comments.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_compose.documents.comments.create",
    "input": {
      "documentId": "149c1faf-3b05-4194-930a-04d2022ff964",
      "body": "Please confirm the evidence.",
      "mentionedUserIds": [
        "user_reviewer",
        "user_test_1",
        "user_reviewer"
      ]
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "comment": {
    "id": "comment_7701b63b-768d-4488-a5a1-62118f390823",
    "mentionedUserIds": [
      "user_reviewer"
    ],
    "createdAt": "2026-10-04T02:26:27.212Z"
  }
}

HTTP 201. Expect HTTP 201 with comment.id and the deduplicated mentionedUserIds. Retain the comment id and request evidence. Compose has no published comment-read or comment-delete action; authorized organization export can inspect saved rows.

Another supported request

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: Compose notification workflows > Notify rejection cannot roll back the persisted transition.

Input · payload.json:

{
  "documentId": "d47f02ec-e1e6-4266-bead-234031789d1b",
  "body": "Please review.",
  "mentionedUserIds": [
    "user_reviewer"
  ]
}

CLI:

topolo actions validate app_topolo_compose.documents.comments.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_compose.documents.comments.create",
    "input": {
      "documentId": "d47f02ec-e1e6-4266-bead-234031789d1b",
      "body": "Please review.",
      "mentionedUserIds": [
        "user_reviewer"
      ]
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "comment": {
    "id": "comment_6f3c6895-94a0-42cc-941d-4415ffafc8a5",
    "mentionedUserIds": [
      "user_reviewer"
    ],
    "createdAt": "2026-10-04T02:26:27.235Z"
  }
}

HTTP 201. Expect HTTP 201 with comment.id and the deduplicated mentionedUserIds. Retain the comment id and request evidence. Compose has no published comment-read or comment-delete action; authorized organization export can inspect saved rows.

Refused request · HTTP 400

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: Compose notification workflows > rejects invalid workflow input and missing documents without persistence.

Input · payload.json:

{
  "mentionedUserIds": [],
  "documentId": "647ff33b-dfc7-4ca0-bb1b-db3f248691e9"
}

CLI:

topolo actions validate app_topolo_compose.documents.comments.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 400:

{
  "error": "body_required"
}

HTTP 400. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Refused request · HTTP 404

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: Compose notification workflows > rejects invalid workflow input and missing documents without persistence.

Input · payload.json:

{
  "documentId": "missing",
  "body": "No document",
  "mentionedUserIds": []
}

CLI:

topolo actions validate app_topolo_compose.documents.comments.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": "not_found"
}

HTTP 404. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Refused request · HTTP 403

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: each grant level against each route > 'POST' '/api/documents/{documentId}/comments' with a 'read' grant.

Input · payload.json:

{
  "documentId": "documentId_missing"
}

CLI:

topolo actions validate app_topolo_compose.documents.comments.create --data @payload.json --json
topolo actions plan app_topolo_compose.documents.comments.create --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": "This workspace requires read_write access",
  "code": "workspace_access_insufficient"
}

HTTP 403. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Verify the result

• Expect HTTP 201 with comment.id and the deduplicated mentionedUserIds.
• Retain the comment id and request evidence. Compose has no published comment-read or comment-delete action; authorized organization export can inspect saved rows.

Errors and recovery

• body_required (HTTP 400): Correct the exact discovered input fields; refused fixtures are not successful requests.
• not_found (HTTP 404): Discover the accessible document and version in the selected workspace. A missing or inaccessible id is not permission to create a replacement.
• This workspace requires read_write access (HTTP 403): Verify the authenticated organization, application permission and granted workspace. For reviewer_required, use the legitimately assigned reviewer; requesting review grants no access.

Auth, action-input validation and platform resource resolution can refuse a request before its handler. Retain the exact error, request id and context; requesting another context is not a legitimate way to bypass a refusal.

Recovery boundary

No comment-delete action is published. Do not claim rollback through document editing or notification deletion; record a correction using a new authorized comment if required.

Related actions

• Get Compose document: Read one document in the authorized organization and workspace, including current markdown, provenance, approval metadata and archival state. This read can initialize the local workspace mirror.
• Export Compose organization data: Export Compose-owned documents, versions, comments, review requests, export attempts and workspace mirrors across the authenticated organization. This private-data export requires privacy:read and explicit authorization.

Evidence

Responses were captured from the actual Compose Worker using synthetic users, organizations, content and identifiers. Tests simulate Auth, Nexus, Notify, metering and platform workspace transport and use an in-memory D1 adapter or local SQLite. They prove local handler behavior, not live model correctness, provider cost, notification delivery, real workspace grants or cross-store atomicity. HTTP 204 responses are exactly empty strings in the SDK transport. Replace fixture identifiers through credential-scoped discovery. Capture digests and test scenarios are retained in the source fixture records.