僅在使用時載入搜尋。在下方瀏覽所有類別。

MCP 工具

取得專案

sosoapi_get_project

依 id 讀取單一專案:名稱、生命週期狀態,以及後續寫入所需的生命週期與預設值版本。

閱讀 Markdown

設定與傳輸方式

設定: full · 傳輸方式: stdio、http

選擇 core 或 full 以控制用戶端顯示的工具;這不會變更權限。本機檔案上傳需要 stdio,無法透過 HTTP 使用。設定 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索結果加入輸出結構描述。無論是否啟用此設定,工具皆會回傳結構化結果。

權限與副作用

註解幫助用戶端描述工具。每次呼叫仍會檢查使用者身分驗證、角色、資源存取和能力授權。

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

輸入欄位

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

輸入欄位
欄位 / 分支類型 / 必填約束
$object在父物件中必填
  • additionalProperties: false
idstring在父物件中必填
  • format: "uuid"
include_versionboolean選填/項目

選填。true 會將資源版本加入回應。

—
完整 JSON Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

結構化輸出

此 schema 描述成功工具結果中的 structuredContent。MCP 回應也包含 content,並可能在呼叫失敗時設定 isError。對於發布,請讀取貼文的最終結果,不要把已接受的請求或文字回應當作確認。連結的 API 操作說明了權限和重試規則。

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

結構化輸出
欄位 / 分支類型 / 必填約束
$object在父物件中必填
  • additionalProperties: false
projectobject在父物件中必填
  • additionalProperties: false
project.idstring在父物件中必填
  • format: "uuid"
project.workspace_idstring在父物件中必填
  • format: "uuid"
project.namestring在父物件中必填
  • minLength: 1
  • maxLength: 200
project.operational_statestring在父物件中必填
  • enum: ["active","archived"]
project.lifecycle_versioninteger在父物件中必填
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
project.defaults_versioninteger在父物件中必填
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
project.archived_atstring | null在父物件中必填—
project.archived_atanyOf 1string在父物件中必填—
project.archived_atanyOf 2null在父物件中必填—
project.archived_bystring | null在父物件中必填—
project.archived_byanyOf 1string在父物件中必填
  • format: "uuid"
project.archived_byanyOf 2null在父物件中必填—
project.archived_by_api_key_idstring | null在父物件中必填—
project.archived_by_api_key_idanyOf 1string在父物件中必填
  • format: "uuid"
project.archived_by_api_key_idanyOf 2null在父物件中必填—
project.created_atstring在父物件中必填—
project.updated_atstring在父物件中必填—
project.versioninteger選填/項目
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
完整 JSON Schema
{
  "type": "object",
  "properties": {
    "project": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "workspace_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "operational_state": {
          "type": "string",
          "enum": [
            "active",
            "archived"
          ]
        },
        "lifecycle_version": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "defaults_version": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "archived_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "archived_by": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        },
        "archived_by_api_key_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "version": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "id",
        "workspace_id",
        "name",
        "operational_state",
        "lifecycle_version",
        "defaults_version",
        "archived_at",
        "archived_by",
        "archived_by_api_key_id",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "project"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

工具呼叫範例

這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材,並將日期替換為已確認的發布時間。提交寫入前,請檢查帳號資格。本頁不會傳送 API 請求。

{
  "name": "sosoapi_get_project",
  "arguments": {
    "id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "project": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "name": "example",
    "operational_state": "active",
    "lifecycle_version": 1,
    "defaults_version": 1,
    "archived_at": null,
    "archived_by": null,
    "archived_by_api_key_id": null,
    "created_at": "example",
    "updated_at": "example"
  }
}
安裝或連結 MCP