Ferramenta MCP
Obter acesso comercial
sosoapi_get_commercial_accessConsulte informações de plano e cotas da conta de cobrança de um Workspace, além de commercial_access_mode (off, shadow ou enforce).
Ler como MarkdownPerfis e transportes
Perfis: full · Transportes: stdio, http
Escolha core ou full para controlar quais ferramentas seu cliente vê; isso não altera suas permissões. O envio de arquivos locais exige stdio e não está disponível por HTTP. Defina SOSOAPI_OUTPUT_SCHEMAS=1 para incluir schemas de saída na descoberta. As ferramentas retornam resultados estruturados com ou sem essa configuração.
Permissões e efeitos colaterais
As anotações ajudam os clientes a descrever uma ferramenta. Cada chamada ainda verifica autenticação, função, acesso a recursos e concessões de capacidades do usuário.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /identity-api/commercial-access/status: agent:operate · synchronous_http_response
Campos de entrada
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
workspace_id | stringObrigatório no objeto pai |
|
JSON Schema completo
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"workspace_id"
],
"additionalProperties": false
}Saída estruturada
Este schema descreve structuredContent em um resultado de ferramenta bem-sucedido. A resposta MCP também inclui content e pode definir isError quando uma chamada falha. Para publicações, consulte o resultado final do post em vez de tratar uma requisição aceita ou resposta de texto como confirmação. A operação de API vinculada explica as permissões e regras de repetição.
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
billing_account_id | stringObrigatório no objeto pai |
|
plan_key | stringObrigatório no objeto pai |
|
plan_version | integerObrigatório no objeto pai |
|
payment_state | stringObrigatório no objeto pai |
|
entitlement_source | stringObrigatório no objeto pai |
|
has_stripe_customer | booleanObrigatório no objeto pai | — |
cycle | objectObrigatório no objeto pai |
|
cycle.period_start | stringObrigatório no objeto pai |
|
cycle.period_end | stringObrigatório no objeto pai |
|
cycle.reset_at | stringObrigatório no objeto pai |
|
quota | objectObrigatório no objeto pai |
|
quota.successful_destination_publishes | objectObrigatório no objeto pai |
|
quota.successful_destination_publishes.limit | integerObrigatório no objeto pai |
|
quota.successful_destination_publishes.reserved | integerObrigatório no objeto pai |
|
quota.successful_destination_publishes.consumed | integerObrigatório no objeto pai |
|
quota.successful_destination_publishes.remaining | integerObrigatório no objeto pai |
|
quota.pending_scheduled_posts | objectObrigatório no objeto pai |
|
quota.pending_scheduled_posts.limit | integerObrigatório no objeto pai |
|
quota.pending_scheduled_posts.active | integerObrigatório no objeto pai |
|
quota.pending_scheduled_posts.remaining | integerObrigatório no objeto pai |
|
quota.connected_social_accounts | objectObrigatório no objeto pai |
|
quota.connected_social_accounts.limit | integerObrigatório no objeto pai |
|
quota.connected_social_accounts.active | integerObrigatório no objeto pai |
|
quota.connected_social_accounts.remaining | integerObrigatório no objeto pai |
|
history_days | integerObrigatório no objeto pai |
|
capabilities | objectObrigatório no objeto pai |
|
capabilities.* | any JSON valueOpcional / item | — |
actor_user_id | stringObrigatório no objeto pai |
|
workspace_id | stringObrigatório no objeto pai |
|
billing_account_kind | stringObrigatório no objeto pai |
|
commercial_access_mode | stringObrigatório no objeto pai |
|
JSON Schema completo
{
"type": "object",
"properties": {
"billing_account_id": {
"type": "string",
"format": "uuid"
},
"plan_key": {
"type": "string",
"enum": [
"free",
"founding_pro"
]
},
"plan_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"payment_state": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"entitlement_source": {
"type": "string",
"enum": [
"default",
"stripe",
"internal_test",
"reconciliation",
"manual"
]
},
"has_stripe_customer": {
"type": "boolean"
},
"cycle": {
"type": "object",
"properties": {
"period_start": {
"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)))$"
},
"period_end": {
"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)))$"
},
"reset_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": [
"period_start",
"period_end",
"reset_at"
],
"additionalProperties": false
},
"quota": {
"type": "object",
"properties": {
"successful_destination_publishes": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reserved": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"consumed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remaining": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"limit",
"reserved",
"consumed",
"remaining"
],
"additionalProperties": false
},
"pending_scheduled_posts": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"active": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remaining": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"limit",
"active",
"remaining"
],
"additionalProperties": false
},
"connected_social_accounts": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"active": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remaining": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"limit",
"active",
"remaining"
],
"additionalProperties": false
}
},
"required": [
"successful_destination_publishes",
"pending_scheduled_posts",
"connected_social_accounts"
],
"additionalProperties": false
},
"history_days": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"capabilities": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"actor_user_id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"billing_account_kind": {
"type": "string",
"const": "personal"
},
"commercial_access_mode": {
"type": "string",
"enum": [
"off",
"shadow",
"enforce"
]
}
},
"required": [
"billing_account_id",
"plan_key",
"plan_version",
"payment_state",
"entitlement_source",
"has_stripe_customer",
"cycle",
"quota",
"history_days",
"capabilities",
"actor_user_id",
"workspace_id",
"billing_account_kind",
"commercial_access_mode"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Exemplo de chamada de ferramenta
Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.
{
"name": "sosoapi_get_commercial_access",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"billing_account_id": "11111111-1111-4111-8111-111111111111",
"plan_key": "free",
"plan_version": 1,
"payment_state": "example",
"entitlement_source": "default",
"has_stripe_customer": false,
"cycle": {
"period_start": "2099-01-15T09:00:00Z",
"period_end": "2099-01-15T09:00:00Z",
"reset_at": "2099-01-15T09:00:00Z"
},
"quota": {
"successful_destination_publishes": {
"limit": 0,
"reserved": 0,
"consumed": 0,
"remaining": 0
},
"pending_scheduled_posts": {
"limit": 0,
"active": 0,
"remaining": 0
},
"connected_social_accounts": {
"limit": 0,
"active": 0,
"remaining": 0
}
},
"history_days": 1,
"capabilities": {},
"actor_user_id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"billing_account_kind": "personal",
"commercial_access_mode": "off"
}