MCP tool

Read a selected research corpus overview

sosoapi_research_projects_overview

Read deterministic counts for an exact sealed corpus; selected items are not audience or market size. Requires agent:research.

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": true
}

/research-api/projects/overview: agent:research · currently authorized exact Research resource data

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 / branch	Type / required	Constraints
`$`	`object`Required in parent	`additionalProperties: false`
`workspace_id`	`string`Required in parent	`format: "uuid"`
`project_id`	`string`Required in parent	`format: "uuid"`
`project_revision`	`integer`Required in parent	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`corpus_snapshot_id`	`string`Required in parent	`format: "uuid"`

Complete JSON Schema

{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "project_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "corpus_snapshot_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspace_id",
    "project_id",
    "project_revision",
    "corpus_snapshot_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 / branch	Type / required	Constraints
`$`	`object`Required in parent	`additionalProperties: false`
`project_id`	`string`Required in parent	`format: "uuid"`
`project_revision`	`integer`Required in parent	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`corpus_snapshot_id`	`string`Required in parent	`format: "uuid"`
`method_version`	`string`Required in parent	`const: "literal-mentions/v1"`
`coverage`	`string`Required in parent	`enum: ["supplied_set","bounded_sample","partial"]`
`evidence_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`unique_items`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`brand_union_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`overlap_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`brands`	`array`Required in parent	`maxItems: 20`
`brands[]`	`object`Optional / item	`additionalProperties: false`
`brands[].id`	`string`Required in parent	`format: "uuid"`
`brands[].name`	`string`Required in parent	`minLength: 1` `maxLength: 100`
`brands[].matched_items`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`brands[].observed_mention_share`	`number \| null`Required in parent	—
`brands[].observed_mention_share`anyOf 1	`number`Required in parent	`minimum: 0` `maximum: 1`
`brands[].observed_mention_share`anyOf 2	`null`Required in parent	—
`brands[].evidence`	`array`Required in parent	`maxItems: 500`
`brands[].evidence[]`	`object`Optional / item	`additionalProperties: false`
`brands[].evidence[].evidence_id`	`string`Required in parent	`format: "uuid"`
`brands[].evidence[].revision`	`integer`Required in parent	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`languages`	`array`Required in parent	`maxItems: 501`
`languages[]`	`object`Optional / item	`additionalProperties: false`
`languages[].language`	`string \| null`Required in parent	—
`languages[].language`anyOf 1	`string`Required in parent	`minLength: 1` `maxLength: 35`
`languages[].language`anyOf 2	`null`Required in parent	—
`languages[].item_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`platforms`	`array`Required in parent	`maxItems: 8`
`platforms[]`	`object`Optional / item	`additionalProperties: false`
`platforms[].platform`	`string \| null`Required in parent	—
`platforms[].platform`anyOf 1	`string`Required in parent	`enum: ["threads","instagram","facebook","youtube","x","reddit","web"]`
`platforms[].platform`anyOf 2	`null`Required in parent	—
`platforms[].item_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`sources`	`array`Required in parent	`maxItems: 3`
`sources[]`	`object`Optional / item	`additionalProperties: false`
`sources[].category`	`string`Required in parent	`enum: ["your_accounts","public_posts","team_notes"]`
`sources[].item_count`	`integer`Required in parent	`minimum: 0` `maximum: 9007199254740991`
`history`	`object`Required in parent	`additionalProperties: false`
`history.eligible`	`boolean`Required in parent	`const: false`
`history.reason`	`string`Required in parent	`const: "insufficient_comparable_history"`

Complete JSON Schema

{
  "type": "object",
  "properties": {
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "project_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "corpus_snapshot_id": {
      "type": "string",
      "format": "uuid"
    },
    "method_version": {
      "type": "string",
      "const": "literal-mentions/v1"
    },
    "coverage": {
      "type": "string",
      "enum": [
        "supplied_set",
        "bounded_sample",
        "partial"
      ]
    },
    "evidence_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "unique_items": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "brand_union_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "overlap_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "brands": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "matched_items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "observed_mention_share": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0,
                "maximum": 1
              },
              {
                "type": "null"
              }
            ]
          },
          "evidence": {
            "maxItems": 500,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "evidence_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "evidence_id",
                "revision"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "name",
          "matched_items",
          "observed_mention_share",
          "evidence"
        ],
        "additionalProperties": false
      }
    },
    "languages": {
      "maxItems": 501,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 35
              },
              {
                "type": "null"
              }
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "language",
          "item_count"
        ],
        "additionalProperties": false
      }
    },
    "platforms": {
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "platform": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "threads",
                  "instagram",
                  "facebook",
                  "youtube",
                  "x",
                  "reddit",
                  "web"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "platform",
          "item_count"
        ],
        "additionalProperties": false
      }
    },
    "sources": {
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "enum": [
              "your_accounts",
              "public_posts",
              "team_notes"
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "category",
          "item_count"
        ],
        "additionalProperties": false
      }
    },
    "history": {
      "type": "object",
      "properties": {
        "eligible": {
          "type": "boolean",
          "const": false
        },
        "reason": {
          "type": "string",
          "const": "insufficient_comparable_history"
        }
      },
      "required": [
        "eligible",
        "reason"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "project_id",
    "project_revision",
    "corpus_snapshot_id",
    "method_version",
    "coverage",
    "evidence_count",
    "unique_items",
    "brand_union_count",
    "overlap_count",
    "brands",
    "languages",
    "platforms",
    "sources",
    "history"
  ],
  "$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_research_projects_overview",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "project_id": "11111111-1111-4111-8111-111111111111",
    "project_revision": 1,
    "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111",
  "method_version": "literal-mentions/v1",
  "coverage": "supplied_set",
  "evidence_count": 0,
  "unique_items": 0,
  "brand_union_count": 0,
  "overlap_count": 0,
  "brands": [],
  "languages": [],
  "platforms": [],
  "sources": [],
  "history": {
    "eligible": false,
    "reason": "insufficient_comparable_history"
  }
}

/research-api/projects/overview

Install or connect MCP

Privacy preferences

Necessary features

Optional usage analytics

Also allow session replay on this public website

Read a selected research corpus overview

Profiles and transports

Permissions and side effects

Input fields

Structured output

Example tool call

structuredContent

Read a selected research corpus overview

Profiles and transports

Permissions and side effects

Input fields

Structured output

Example tool call

structuredContent

Underlying API operations