設定與傳輸方式
設定: core、full · 傳輸方式: stdio、http
選擇 core 或 full 以控制用戶端顯示的工具;這不會變更權限。本機檔案上傳需要 stdio,無法透過 HTTP 使用。設定 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索結果加入輸出結構描述。無論是否啟用此設定,工具皆會回傳結構化結果。
權限與副作用
註解幫助用戶端描述工具。每次呼叫仍會檢查使用者身分驗證、角色、資源存取和能力授權。
{
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}- /community-engagement-api/comments/create:agent:engage · 平台終端收據
輸入欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
social_account_id | string在父物件中必填 |
|
target | object在父物件中必填 | — |
targetanyOf 1 | object在父物件中必填 |
|
target.kindanyOf 1 | string在父物件中必填 |
|
target.social_post_idanyOf 1 | string在父物件中必填 |
|
targetanyOf 2 | object在父物件中必填 |
|
target.kindanyOf 2 | string在父物件中必填 |
|
target.social_comment_idanyOf 2 | string在父物件中必填 |
|
message | string在父物件中必填 |
|
idempotency_key | string在父物件中必填 |
|
完整 JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"target": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"post"
]
},
"social_post_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"kind",
"social_post_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"comment"
]
},
"social_comment_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"kind",
"social_comment_id"
],
"additionalProperties": false
}
]
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"idempotency_key": {
"type": "string",
"format": "uuid"
}
},
"required": [
"workspace_id",
"social_account_id",
"target",
"message",
"idempotency_key"
],
"additionalProperties": false
}結構化輸出
此 schema 描述成功工具結果中的 structuredContent。MCP 回應也包含 content,並可能在呼叫失敗時設定 isError。對於發布,請讀取貼文的最終結果,不要把已接受的請求或文字回應當作確認。連結的 API 操作說明了權限和重試規則。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
contract_version | string在父物件中必填 |
|
replayed | boolean在父物件中必填 | — |
action | object在父物件中必填 |
|
action.action_id | string在父物件中必填 |
|
action.workspace_id | string在父物件中必填 |
|
action.social_account_id | string在父物件中必填 |
|
action.target | object在父物件中必填 | — |
action.targetoneOf 1 | object在父物件中必填 |
|
action.target.kindoneOf 1 | string在父物件中必填 |
|
action.target.social_post_idoneOf 1 | string在父物件中必填 |
|
action.targetoneOf 2 | object在父物件中必填 |
|
action.target.kindoneOf 2 | string在父物件中必填 |
|
action.target.social_post_idoneOf 2 | string在父物件中必填 |
|
action.target.social_comment_idoneOf 2 | string在父物件中必填 |
|
action.content_sha256 | string在父物件中必填 |
|
action.idempotency_key | string在父物件中必填 |
|
action.status | string在父物件中必填 |
|
action.poll_after_ms | integer在父物件中必填 |
|
完整 JSON Schema
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "community-engagement/v1"
},
"replayed": {
"type": "boolean"
},
"action": {
"type": "object",
"properties": {
"action_id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"target": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "post"
},
"social_post_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"kind",
"social_post_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "comment"
},
"social_post_id": {
"type": "string",
"format": "uuid"
},
"social_comment_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"kind",
"social_post_id",
"social_comment_id"
],
"additionalProperties": false
}
]
},
"content_sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"idempotency_key": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"executing",
"succeeded",
"attention",
"failed"
]
},
"poll_after_ms": {
"type": "integer",
"minimum": 0,
"maximum": 300000
}
},
"required": [
"action_id",
"workspace_id",
"social_account_id",
"target",
"content_sha256",
"idempotency_key",
"status",
"poll_after_ms"
],
"additionalProperties": false
}
},
"required": [
"contract_version",
"replayed",
"action"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}工具呼叫範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材,並將日期替換為已確認的發布時間。提交寫入前,請檢查帳號資格。本頁不會傳送 API 請求。
{
"name": "sosoapi_create_comment",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"target": {
"kind": "post",
"social_post_id": "11111111-1111-4111-8111-111111111111"
},
"message": "example",
"idempotency_key": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"contract_version": "community-engagement/v1",
"replayed": false,
"action": {
"action_id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"target": {
"kind": "post",
"social_post_id": "11111111-1111-4111-8111-111111111111"
},
"content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"idempotency_key": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"poll_after_ms": 0
}
}