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

MCPツール

プロジェクトの一覧を取得

sosoapi_list_projects

ワークスペースのプロジェクト(出典と既定アカウントを管理する任意の層)の一覧と、アクティブなプロジェクトを取得します。

Markdownで読む

プロファイルと通信方式

プロファイル: full · 通信方式: stdio, http

coreまたはfullで表示ツールを選べますが権限は変わりません。ローカルアップロードはstdioのみでHTTPは非対応です。SOSOAPI_OUTPUT_SCHEMAS=1で検出時に出力スキーマを含めます。設定に関係なく構造化結果を返します。

権限と副作用

注釈はクライアントがツールを説明するためのものです。各呼び出しでは引き続き認証、ロール、リソースアクセス、機能権限を確認します。

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

入力フィールド

必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。

入力フィールド
フィールド/分岐型/必須制約
$object親要素内で必須
  • additionalProperties: false
workspace_idstring親要素内で必須
  • format: "uuid"
limitinteger任意/項目

ページ件数は1~100。limitかcursorを送るとカーソル方式に切り替わり、next_cursorを返します。

  • minimum: 1
  • maximum: 100
cursorstring任意/項目

不透明なカーソルです。前ページのnext_cursorを変更せずに指定します。最初のページでは省略します。各ページで同じフィルターを送信してください。

  • minLength: 1
  • maxLength: 512
include_versionboolean任意/項目

任意。trueでリソースのバージョンを返します。

—
完全なJSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Opaque cursor: the next_cursor of the previous page, unchanged. Omit it for the first page. The same filters must be sent with every page."
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

構造化された出力

このスキーマは、成功時のツール結果に含まれるstructuredContentを説明します。MCPレスポンスはcontentも含み、失敗時にisErrorを設定する場合があります。公開では、受理やテキスト応答を確認済みと扱わず、投稿の最終結果を取得してください。権限・再試行ルールはリンク先のAPI操作をご覧ください。

必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。

構造化された出力
フィールド/分岐型/必須制約
$object親要素内で必須
  • additionalProperties: false
projectsarray親要素内で必須—
projects[]object任意/項目
  • additionalProperties: false
projects[].idstring親要素内で必須
  • format: "uuid"
projects[].workspace_idstring親要素内で必須
  • format: "uuid"
projects[].namestring親要素内で必須
  • minLength: 1
  • maxLength: 200
projects[].operational_statestring親要素内で必須
  • enum: ["active","archived"]
projects[].lifecycle_versioninteger親要素内で必須
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
projects[].defaults_versioninteger親要素内で必須
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
projects[].archived_atstring | null親要素内で必須—
projects[].archived_atanyOf 1string親要素内で必須—
projects[].archived_atanyOf 2null親要素内で必須—
projects[].archived_bystring | null親要素内で必須—
projects[].archived_byanyOf 1string親要素内で必須
  • format: "uuid"
projects[].archived_byanyOf 2null親要素内で必須—
projects[].archived_by_api_key_idstring | null親要素内で必須—
projects[].archived_by_api_key_idanyOf 1string親要素内で必須
  • format: "uuid"
projects[].archived_by_api_key_idanyOf 2null親要素内で必須—
projects[].created_atstring親要素内で必須—
projects[].updated_atstring親要素内で必須—
projects[].versioninteger任意/項目
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
active_project_idstring | null親要素内で必須—
active_project_idanyOf 1string親要素内で必須
  • format: "uuid"
active_project_idanyOf 2null親要素内で必須—
next_cursorstring | null任意/項目

limitかcursorを送った場合のみ存在します。最終ページはnullです。

—
next_cursoranyOf 1string任意/項目—
next_cursoranyOf 2null任意/項目—
完全なJSON Schema
{
  "type": "object",
  "properties": {
    "projects": {
      "type": "array",
      "items": {
        "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
      }
    },
    "active_project_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "next_cursor": {
      "description": "Present only when the request sent limit or cursor. Null on the last page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "projects",
    "active_project_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

ツール呼び出しの例

スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。

{
  "name": "sosoapi_list_projects",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "projects": [],
  "active_project_id": null
}
MCPをインストール・接続