Search loads only when you use it. Browse all categories below.

MCP tool

Get community comment status

sosoapi_get_comment_action_status

Read the sanitized terminal receipt for a direct comment action.

Read as Markdown

Profiles and transports

Profiles: core, full · Transports: stdio, http

Choose core or full to control which tools your client sees; this does not change its permissions. Local file upload requires stdio and is unavailable over HTTP. Set SOSOAPI_OUTPUT_SCHEMAS=1 to include output schemas in discovery. Tools return structured results with or without that setting.

Permissions and side effects

Annotations help clients describe a tool. Each call still checks the user’s authentication, role, resource access and capability grants.

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": true
}

Input fields

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Input fields
Field / branchType / requiredConstraints
$objectRequired in parent
  • additionalProperties: false
workspace_idstringRequired in parent
  • format: "uuid"
action_idstringRequired in parent
  • format: "uuid"
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "action_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspace_id",
    "action_id"
  ],
  "additionalProperties": false
}

Structured output

This schema describes structuredContent in a successful tool result. The MCP response also includes content and may set isError when a call fails. For publishing, read the post’s final result rather than treating an accepted request or text response as confirmation. The linked API operation explains permissions and retry rules.

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Structured output
Field / branchType / requiredConstraints
$objectRequired in parent
  • additionalProperties: false
contract_versionstringRequired in parent
  • const: "community-engagement/v1"
actionobjectRequired in parent
  • additionalProperties: false
action.action_idstringRequired in parent
  • format: "uuid"
action.workspace_idstringRequired in parent
  • format: "uuid"
action.social_account_idstringRequired in parent
  • format: "uuid"
action.targetobjectRequired in parent—
action.targetoneOf 1objectRequired in parent
  • additionalProperties: false
action.target.kindoneOf 1stringRequired in parent
  • const: "post"
action.target.social_post_idoneOf 1stringRequired in parent
  • format: "uuid"
action.targetoneOf 2objectRequired in parent
  • additionalProperties: false
action.target.kindoneOf 2stringRequired in parent
  • const: "comment"
action.target.social_post_idoneOf 2stringRequired in parent
  • format: "uuid"
action.target.social_comment_idoneOf 2stringRequired in parent
  • format: "uuid"
action.content_sha256stringRequired in parent
  • pattern: "^[a-f0-9]{64}$"
action.idempotency_keystringRequired in parent
  • format: "uuid"
action.statusstringRequired in parent
  • enum: ["queued","executing","succeeded","attention","failed"]
action.attempt_countintegerRequired in parent
  • minimum: 0
  • maximum: 9007199254740991
action.created_atstringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
action.updated_atstringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
receiptobject | nullRequired in parent—
receiptanyOf 1objectRequired in parent
  • additionalProperties: false
receipt.action_idanyOf 1stringRequired in parent
  • format: "uuid"
receipt.statusanyOf 1stringRequired in parent
  • enum: ["succeeded","attention","failed"]
receipt.provider_terminalanyOf 1booleanRequired in parent—
receipt.provider_comment_idanyOf 1string | nullRequired in parent—
receipt.provider_comment_idanyOf 1 / anyOf 1stringRequired in parent
  • minLength: 1
  • maxLength: 512
receipt.provider_comment_idanyOf 1 / anyOf 2nullRequired in parent—
receipt.terminal_atanyOf 1stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
receipt.attention_reasonanyOf 1string | nullRequired in parent—
receipt.attention_reasonanyOf 1 / anyOf 1stringRequired in parent
  • maxLength: 500
receipt.attention_reasonanyOf 1 / anyOf 2nullRequired in parent—
receiptanyOf 2nullRequired in parent—
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "community-engagement/v1"
    },
    "action": {
      "type": "object",
      "properties": {
        "action_id": {
          "type": "string",
          "format": "uuid"
        },
        "workspace_id": {
          "type": "string",
          "format": "uuid"
        },
        "social_account_id": {
          "type": "string",
          "format": "uuid"
        },
        "target": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "post"
                },
                "social_post_id": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "required": [
                "kind",
                "social_post_id"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "comment"
                },
                "social_post_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "social_comment_id": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "required": [
                "kind",
                "social_post_id",
                "social_comment_id"
              ],
              "additionalProperties": false
            }
          ]
        },
        "content_sha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "idempotency_key": {
          "type": "string",
          "format": "uuid"
        },
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "executing",
            "succeeded",
            "attention",
            "failed"
          ]
        },
        "attempt_count": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      },
      "required": [
        "action_id",
        "workspace_id",
        "social_account_id",
        "target",
        "content_sha256",
        "idempotency_key",
        "status",
        "attempt_count",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    },
    "receipt": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "action_id": {
              "type": "string",
              "format": "uuid"
            },
            "status": {
              "type": "string",
              "enum": [
                "succeeded",
                "attention",
                "failed"
              ]
            },
            "provider_terminal": {
              "type": "boolean"
            },
            "provider_comment_id": {
              "anyOf": [
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 512
                },
                {
                  "type": "null"
                }
              ]
            },
            "terminal_at": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "attention_reason": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "action_id",
            "status",
            "provider_terminal",
            "provider_comment_id",
            "terminal_at",
            "attention_reason"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "contract_version",
    "action",
    "receipt"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Example tool call

These examples use fictional values checked against the schemas. Replace the IDs with ones you are authorized to use, the media with ready assets and the dates with your confirmed publishing time. Check the account’s eligibility before submitting a write. This page sends no API requests.

{
  "name": "sosoapi_get_comment_action_status",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "action_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "contract_version": "community-engagement/v1",
  "action": {
    "action_id": "11111111-1111-4111-8111-111111111111",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "social_account_id": "11111111-1111-4111-8111-111111111111",
    "target": {
      "kind": "post",
      "social_post_id": "11111111-1111-4111-8111-111111111111"
    },
    "content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "idempotency_key": "11111111-1111-4111-8111-111111111111",
    "status": "queued",
    "attempt_count": 0,
    "created_at": "2099-01-15T09:00:00Z",
    "updated_at": "2099-01-15T09:00:00Z"
  },
  "receipt": null
}
Install or connect MCP