検索は使用時のみ読み込みます。以下ですべてのカテゴリを閲覧できます。

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
}

構造化された出力

このスキーマは、成功時のツール結果に含まれる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、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページは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をインストール・接続