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

MCP tool

Get community summary

sosoapi_get_community_engagement_summary

Read a Workspace's community operations summary: lane mode, backlog, response times, action statuses and provider rates.

Read as Markdown

Profiles and transports

Profiles: 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": false
}

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"
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspace_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"
summaryobjectRequired in parent
  • additionalProperties: false
summary.lane_modestringRequired in parent
  • enum: ["off","canary","on"]
summary.backlogobjectRequired in parent
  • additionalProperties: {"type":"integer","minimum":0,"maximum":9007199254740991}
summary.backlog.*integerOptional / item
  • minimum: 0
  • maximum: 9007199254740991
summary.response_time_secondsobjectRequired in parent
  • additionalProperties: false
summary.response_time_seconds.mediannumber | nullRequired in parent—
summary.response_time_seconds.mediananyOf 1numberRequired in parent—
summary.response_time_seconds.mediananyOf 2nullRequired in parent—
summary.response_time_seconds.p95number | nullRequired in parent—
summary.response_time_seconds.p95anyOf 1numberRequired in parent—
summary.response_time_seconds.p95anyOf 2nullRequired in parent—
summary.action_statusesobjectRequired in parent
  • additionalProperties: {"type":"integer","minimum":0,"maximum":9007199254740991}
summary.action_statuses.*integerOptional / item
  • minimum: 0
  • maximum: 9007199254740991
summary.provider_rateobjectRequired in parent
  • additionalProperties: {"type":"integer","minimum":0,"maximum":9007199254740991}
summary.provider_rate.*integerOptional / item
  • minimum: 0
  • maximum: 9007199254740991
summary.partial_failure_countintegerRequired in parent
  • minimum: 0
  • maximum: 9007199254740991
summary.known_common_dependenciesarrayRequired in parent—
summary.known_common_dependencies[]stringOptional / item—
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "community-engagement/v1"
    },
    "summary": {
      "type": "object",
      "properties": {
        "lane_mode": {
          "type": "string",
          "enum": [
            "off",
            "canary",
            "on"
          ]
        },
        "backlog": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "response_time_seconds": {
          "type": "object",
          "properties": {
            "median": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            },
            "p95": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "median",
            "p95"
          ],
          "additionalProperties": false
        },
        "action_statuses": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "provider_rate": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "partial_failure_count": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "known_common_dependencies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "lane_mode",
        "backlog",
        "response_time_seconds",
        "action_statuses",
        "provider_rate",
        "partial_failure_count",
        "known_common_dependencies"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "contract_version",
    "summary"
  ],
  "$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_community_engagement_summary",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "contract_version": "community-engagement/v1",
  "summary": {
    "lane_mode": "off",
    "backlog": {},
    "response_time_seconds": {
      "median": null,
      "p95": null
    },
    "action_statuses": {},
    "provider_rate": {},
    "partial_failure_count": 0,
    "known_common_dependencies": []
  }
}
Install or connect MCP