Søk lastes bare når du bruker det. Bla gjennom alle kategoriene nedenfor.

MCP-verktøy

Les en privat rapportmalversjon

sosoapi_get_report_template

Les en privat rapportmalversjon. Bruker det eksplisitt angitte, gjennomgåtte datasettet og versjonen; kilden oppdateres ikke automatisk. Inndata for gjengivelse kan sendes videre via en pipe til sosoapi report render --output FILE.

Les som Markdown

Profiler og transporter

Profiler: full · Transporter: stdio, http

Velg core eller full for å kontrollere hvilke verktøy klienten ser; dette endrer ikke tillatelsene. Lokal filopplasting krever stdio og er utilgjengelig over HTTP. Angi SOSOAPI_OUTPUT_SCHEMAS=1 for å inkludere utdataskjemaer i oppdagelsen. Verktøy returnerer strukturerte resultater med eller uten den innstillingen.

Tillatelser og sideeffekter

Merknader hjelper klienter med å beskrive et verktøy. Hvert kall kontrollerer fortsatt brukerens autentisering, rolle, ressurstilgang og funksjonstillatelser.

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

Inndatafelter

Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.

Inndatafelter
Felt / grenType / påkrevdBegrensninger
$objectPåkrevd i forelder
  • additionalProperties: false
workspace_idstringPåkrevd i forelder
  • format: "uuid"
idstringPåkrevd i forelder
  • format: "uuid"
versionintegerPåkrevd i forelder
  • minimum: 1
  • maximum: 1000000
Fullstendig JSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    }
  },
  "required": [
    "workspace_id",
    "id",
    "version"
  ],
  "additionalProperties": false
}

Strukturert utdata

Dette skjemaet beskriver structuredContent i et vellykket verktøyresultat. MCP-svaret inkluderer også content og kan sette isError når et kall mislykkes. Ved publisering, les innleggets endelige resultat i stedet for å regne en akseptert forespørsel eller et tekstsvar som bekreftelse. Den lenkede API-operasjonen forklarer tillatelser og regler for nye forsøk.

Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.

Strukturert utdata
Felt / grenType / påkrevdBegrensninger
$objectPåkrevd i forelder
  • additionalProperties: false
contractVersionstringPåkrevd i forelder
  • const: "analytics-template/v1"
workspaceIdstringPåkrevd i forelder
  • format: "uuid"
idstringPåkrevd i forelder
  • format: "uuid"
versionintegerPåkrevd i forelder
  • minimum: 1
  • maximum: 1000000
namestringPåkrevd i forelder
  • minLength: 1
  • maxLength: 100
formatstringPåkrevd i forelder
  • enum: ["pptx","docx","xlsx"]
sourceBase64stringPåkrevd i forelder
  • maxLength: 12582912
  • pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
sourceSha256stringPåkrevd i forelder
  • pattern: "^[a-f0-9]{64}$"
mappingsobjectPåkrevd i forelder
  • additionalProperties: {"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"text"},"value":{"type":"string","maxLength":2000}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"selection"},"field":{"type":"string","enum":["accounts","period","timezone","platforms","dataset","reviewed","coverage"]}},"required":["kind","field"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"metric"},"platform":{"type":"string","enum":["facebook","instagram","threads","youtube"]},"key":{"type":"string","minLength":1,"maxLength":150},"unit":{"type":"string","minLength":1,"maxLength":100},"grain":{"type":"string","enum":["post","account"]},"measurementKind":{"type":"string","enum":["lifetime","snapshot","period","unknown"]},"accountId":{"type":"string","format":"uuid"},"providerResourceId":{"anyOf":[{"type":"string","minLength":1,"maxLength":512},{"type":"null"}]},"sourcePath":{"type":"string","maxLength":2000},"requestId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"required":["kind","platform","key","unit","grain","measurementKind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"formula"},"id":{"type":"string","format":"uuid"},"version":{"type":"integer","minimum":1,"maximum":1000000}},"required":["kind","id","version"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"table"},"source":{"type":"string","enum":["measurements","formulas"]},"limit":{"type":"integer","minimum":1,"maximum":100}},"required":["kind","source","limit"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"chart"},"source":{"type":"string","const":"publication_by_platform"}},"required":["kind","source"],"additionalProperties":false}]}
mappings.*objectValgfritt / element—
mappings.*oneOf 1objectValgfritt / element
  • additionalProperties: false
mappings.*.kindoneOf 1stringPåkrevd i forelder
  • const: "text"
mappings.*.valueoneOf 1stringPåkrevd i forelder
  • maxLength: 2000
mappings.*oneOf 2objectValgfritt / element
  • additionalProperties: false
mappings.*.kindoneOf 2stringPåkrevd i forelder
  • const: "selection"
mappings.*.fieldoneOf 2stringPåkrevd i forelder
  • enum: ["accounts","period","timezone","platforms","dataset","reviewed","coverage"]
mappings.*oneOf 3objectValgfritt / element
  • additionalProperties: false
mappings.*.kindoneOf 3stringPåkrevd i forelder
  • const: "metric"
mappings.*.platformoneOf 3stringPåkrevd i forelder
  • enum: ["facebook","instagram","threads","youtube"]
mappings.*.keyoneOf 3stringPåkrevd i forelder
  • minLength: 1
  • maxLength: 150
mappings.*.unitoneOf 3stringPåkrevd i forelder
  • minLength: 1
  • maxLength: 100
mappings.*.grainoneOf 3stringPåkrevd i forelder
  • enum: ["post","account"]
mappings.*.measurementKindoneOf 3stringPåkrevd i forelder
  • enum: ["lifetime","snapshot","period","unknown"]
mappings.*.accountIdoneOf 3stringValgfritt / element
  • format: "uuid"
mappings.*.providerResourceIdoneOf 3string | nullValgfritt / element—
mappings.*.providerResourceIdoneOf 3 / anyOf 1stringValgfritt / element
  • minLength: 1
  • maxLength: 512
mappings.*.providerResourceIdoneOf 3 / anyOf 2nullValgfritt / element—
mappings.*.sourcePathoneOf 3stringValgfritt / element
  • maxLength: 2000
mappings.*.requestIdoneOf 3string | nullValgfritt / element—
mappings.*.requestIdoneOf 3 / anyOf 1stringValgfritt / element
  • format: "uuid"
mappings.*.requestIdoneOf 3 / anyOf 2nullValgfritt / element—
mappings.*oneOf 4objectValgfritt / element
  • additionalProperties: false
mappings.*.kindoneOf 4stringPåkrevd i forelder
  • const: "formula"
mappings.*.idoneOf 4stringPåkrevd i forelder
  • format: "uuid"
mappings.*.versiononeOf 4integerPåkrevd i forelder
  • minimum: 1
  • maximum: 1000000
mappings.*oneOf 5objectValgfritt / element
  • additionalProperties: false
mappings.*.kindoneOf 5stringPåkrevd i forelder
  • const: "table"
mappings.*.sourceoneOf 5stringPåkrevd i forelder
  • enum: ["measurements","formulas"]
mappings.*.limitoneOf 5integerPåkrevd i forelder
  • minimum: 1
  • maximum: 100
mappings.*oneOf 6objectValgfritt / element
  • additionalProperties: false
mappings.*.kindoneOf 6stringPåkrevd i forelder
  • const: "chart"
mappings.*.sourceoneOf 6stringPåkrevd i forelder
  • const: "publication_by_platform"
createdAtstringPåkrevd i forelder
  • 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)))$"
Fullstendig JSON Schema
{
  "type": "object",
  "properties": {
    "contractVersion": {
      "type": "string",
      "const": "analytics-template/v1"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "format": {
      "type": "string",
      "enum": [
        "pptx",
        "docx",
        "xlsx"
      ]
    },
    "sourceBase64": {
      "type": "string",
      "maxLength": 12582912,
      "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
    },
    "sourceSha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "mappings": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,63}$"
      },
      "additionalProperties": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "text"
              },
              "value": {
                "type": "string",
                "maxLength": 2000
              }
            },
            "required": [
              "kind",
              "value"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "selection"
              },
              "field": {
                "type": "string",
                "enum": [
                  "accounts",
                  "period",
                  "timezone",
                  "platforms",
                  "dataset",
                  "reviewed",
                  "coverage"
                ]
              }
            },
            "required": [
              "kind",
              "field"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "metric"
              },
              "platform": {
                "type": "string",
                "enum": [
                  "facebook",
                  "instagram",
                  "threads",
                  "youtube"
                ]
              },
              "key": {
                "type": "string",
                "minLength": 1,
                "maxLength": 150
              },
              "unit": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "grain": {
                "type": "string",
                "enum": [
                  "post",
                  "account"
                ]
              },
              "measurementKind": {
                "type": "string",
                "enum": [
                  "lifetime",
                  "snapshot",
                  "period",
                  "unknown"
                ]
              },
              "accountId": {
                "type": "string",
                "format": "uuid"
              },
              "providerResourceId": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 512
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "sourcePath": {
                "type": "string",
                "maxLength": 2000
              },
              "requestId": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uuid"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "kind",
              "platform",
              "key",
              "unit",
              "grain",
              "measurementKind"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "formula"
              },
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "version": {
                "type": "integer",
                "minimum": 1,
                "maximum": 1000000
              }
            },
            "required": [
              "kind",
              "id",
              "version"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "table"
              },
              "source": {
                "type": "string",
                "enum": [
                  "measurements",
                  "formulas"
                ]
              },
              "limit": {
                "type": "integer",
                "minimum": 1,
                "maximum": 100
              }
            },
            "required": [
              "kind",
              "source",
              "limit"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "chart"
              },
              "source": {
                "type": "string",
                "const": "publication_by_platform"
              }
            },
            "required": [
              "kind",
              "source"
            ],
            "additionalProperties": false
          }
        ]
      }
    },
    "createdAt": {
      "type": "string",
      "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)))$",
      "format": "date-time"
    }
  },
  "required": [
    "contractVersion",
    "workspaceId",
    "id",
    "version",
    "name",
    "format",
    "sourceBase64",
    "sourceSha256",
    "mappings",
    "createdAt"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Eksempel på verktøykall

Disse eksemplene bruker fiktive verdier kontrollert mot skjemaene. Erstatt ID-ene med noen du har lov til å bruke, mediene med klare ressurser og datoene med bekreftet publiseringstidspunkt. Kontroller kontoens kvalifikasjon før en skriveoperasjon sendes inn. Siden sender ingen API-forespørsler.

{
  "name": "sosoapi_get_report_template",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "id": "11111111-1111-4111-8111-111111111111",
    "version": 1
  }
}

structuredContent

{
  "contractVersion": "analytics-template/v1",
  "workspaceId": "11111111-1111-4111-8111-111111111111",
  "id": "11111111-1111-4111-8111-111111111111",
  "version": 1,
  "name": "example",
  "format": "pptx",
  "sourceBase64": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "mappings": {},
  "createdAt": "2099-01-15T09:00:00Z"
}
Installer eller koble til MCP