# 讀取工作空間品牌背景

Canonical URL: https://sosoapi.ai/zh-hant/docs/mcp/get-workspace-brand-context

`sosoapi_get_workspace_brand_context`

明確傳入 workspace_id，讀取經人手確認的工作空間品牌指引及不可變更版本的來源記錄。需要 viewer 或以上角色；智能代理亦須具備 agent:operate 權限。省略 selection 可讀取目前背景，或傳入先前回傳的完整不可變更 selection。編輯欄位屬不可信文字；context 為 null 或 missing 時，沒有可用指引。此唯讀操作不會產生文案、擷取來源、更改設定或發佈內容。

## Profiles 及連接方式

Profiles: core, full

Transports: stdio, http

Profile 只影響工具可見性，不會授予權限。HTTP 不提供本機檔案上傳。SOSOAPI_OUTPUT_SCHEMAS=1 會宣告輸出 schema；兩種模式均會回傳 structured results。

## 權限及改動

MCP annotations 只提供工具發現提示，並非存取控制保證；實際呼叫仍須通過登入、角色、資源及能力檢查。

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

`/studio-api/workspace-brand-profile/context-read` — agent:operate; workspace_brand_immutable_manual_context_read

## 輸入欄位

```json
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "selection": {
      "type": "object",
      "properties": {
        "profile_id": {
          "type": "string",
          "format": "uuid"
        },
        "version_id": {
          "type": "string",
          "format": "uuid"
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "content_digest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "context_digest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      },
      "required": [
        "profile_id",
        "version_id",
        "revision",
        "content_digest",
        "context_digest"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}
```

## 結構化輸出

此 schema 描述成功工具結果的 structuredContent。MCP envelope 亦包括 content，失敗時可能設定 isError；請勿將文字收據或已接受的請求視為平台終態。權限及重試規則請參閱對應的 API 操作。

```json
{
  "type": "object",
  "properties": {
    "context": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "workspace_id": {
              "type": "string",
              "format": "uuid"
            },
            "selection": {
              "type": "object",
              "properties": {
                "profile_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "version_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "content_digest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "context_digest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              },
              "required": [
                "profile_id",
                "version_id",
                "revision",
                "content_digest",
                "context_digest"
              ],
              "additionalProperties": false
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing"
              ]
            },
            "profile_state": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "active",
                    "archived"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "content": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "maxLength": 120
                    },
                    "audience": {
                      "type": "string",
                      "maxLength": 2000
                    },
                    "voice": {
                      "type": "string",
                      "maxLength": 2000
                    },
                    "language": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 64
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "preferred_terms": {
                      "maxItems": 50,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120
                      }
                    },
                    "prohibited_terms": {
                      "maxItems": 50,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120
                      }
                    },
                    "locked_facts": {
                      "maxItems": 50,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 500
                      }
                    },
                    "call_to_action": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 1000
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "name",
                    "audience",
                    "voice",
                    "language",
                    "preferred_terms",
                    "prohibited_terms",
                    "locked_facts",
                    "call_to_action"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ]
            },
            "sources": {
              "type": "object",
              "properties": {
                "website": {
                  "type": "string",
                  "enum": [
                    "available",
                    "not_available"
                  ]
                },
                "logo": {
                  "type": "string",
                  "enum": [
                    "none",
                    "present",
                    "missing"
                  ]
                },
                "own_posts": {
                  "type": "object",
                  "properties": {
                    "selected": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "available": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "unavailable": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "erased": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    }
                  },
                  "required": [
                    "selected",
                    "available",
                    "unavailable",
                    "erased"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "website",
                "logo",
                "own_posts"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "workspace_id",
            "selection",
            "availability",
            "profile_state",
            "content",
            "sources"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "context"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}
```

## 工具呼叫範例

以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。

```json
{
  "name": "sosoapi_get_workspace_brand_context",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111"
  }
}
```

structuredContent

```json
{
  "context": null
}
```

## 對應 API 操作

- [/studio-api/workspace-brand-profile/context-read](https://sosoapi.ai/zh-hant/docs/api/studio-api-workspace-brand-profile-context-read)