Sökningen laddas först när du använder den. Bläddra bland alla kategorier nedan.

MCP-verktyg

Hämta kommersiell åtkomst

sosoapi_get_commercial_access

Läs abonnemangs- och kvotuppgifter för en arbetsytas faktureringskonto samt dess commercial_access_mode (off, shadow eller enforce).

Läs som Markdown

Profiler och transporter

Profiler: full · Transporter: stdio, http

Välj core eller full för att styra vilka verktyg klienten ser; detta ändrar inte dess behörigheter. Lokal filuppladdning kräver stdio och är inte tillgänglig via HTTP. Ange SOSOAPI_OUTPUT_SCHEMAS=1 för att inkludera utdatascheman vid identifiering. Verktygen returnerar strukturerade resultat med eller utan inställningen.

Behörigheter och sidoeffekter

Annoteringar hjälper klienter att beskriva ett verktyg. Varje anrop kontrollerar fortfarande användarens autentisering, roll, resursåtkomst och tilldelade funktionsbehörigheter.

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

Indatafält

Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.

Indatafält
Fält / grenTyp / obligatorisktBegränsningar
$objectObligatoriskt i överordnat objekt
  • additionalProperties: false
workspace_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Strukturerat resultat

Detta schema beskriver structuredContent i ett lyckat verktygsresultat. MCP-svaret innehåller även content och kan ange isError när ett anrop misslyckas. För publicering ska du läsa inläggets slutresultat i stället för att tolka en accepterad begäran eller ett textsvar som bekräftelse. Den länkade API-åtgärden förklarar behörigheter och regler för nya försök.

Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.

Strukturerat resultat
Fält / grenTyp / obligatorisktBegränsningar
$objectObligatoriskt i överordnat objekt
  • additionalProperties: false
billing_account_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
plan_keystringObligatoriskt i överordnat objekt
  • enum: ["free","founding_pro"]
plan_versionintegerObligatoriskt i överordnat objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
payment_statestringObligatoriskt i överordnat objekt
  • minLength: 1
  • maxLength: 64
entitlement_sourcestringObligatoriskt i överordnat objekt
  • enum: ["default","stripe","internal_test","reconciliation","manual"]
has_stripe_customerbooleanObligatoriskt i överordnat objekt—
cycleobjectObligatoriskt i överordnat objekt
  • additionalProperties: false
cycle.period_startstringObligatoriskt i överordnat objekt
  • 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)))$"
cycle.period_endstringObligatoriskt i överordnat objekt
  • 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)))$"
cycle.reset_atstringObligatoriskt i överordnat objekt
  • 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)))$"
quotaobjectObligatoriskt i överordnat objekt
  • additionalProperties: false
quota.successful_destination_publishesobjectObligatoriskt i överordnat objekt
  • additionalProperties: false
quota.successful_destination_publishes.limitintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.successful_destination_publishes.reservedintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.successful_destination_publishes.consumedintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.successful_destination_publishes.remainingintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.pending_scheduled_postsobjectObligatoriskt i överordnat objekt
  • additionalProperties: false
quota.pending_scheduled_posts.limitintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.pending_scheduled_posts.activeintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.pending_scheduled_posts.remainingintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.connected_social_accountsobjectObligatoriskt i överordnat objekt
  • additionalProperties: false
quota.connected_social_accounts.limitintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.connected_social_accounts.activeintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
quota.connected_social_accounts.remainingintegerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
history_daysintegerObligatoriskt i överordnat objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
capabilitiesobjectObligatoriskt i överordnat objekt
  • additionalProperties: {}
capabilities.*any JSON valueValfritt / objekt—
actor_user_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
workspace_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
billing_account_kindstringObligatoriskt i överordnat objekt
  • const: "personal"
commercial_access_modestringObligatoriskt i överordnat objekt
  • enum: ["off","shadow","enforce"]
Fullständigt JSON Schema
{
  "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
}

Exempel på verktygsanrop

Exemplen använder fiktiva värden som kontrollerats mot schemana. Ersätt ID:n med sådana du får använda, medier med färdiga mediefiler och datum med din bekräftade publiceringstid. Kontrollera kontots behörighet före en skrivning. Denna sida skickar inga API-anrop.

{
  "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"
}
Installera eller anslut MCP