Ferramenta MCP

Listar projetos

sosoapi_list_projects

Liste os projetos de um Workspace (uma camada opcional para proveniência e contas padrão) e qual está ativo.

Perfis e transportes

Perfis: full · Transportes: stdio, http

Escolha core ou full para controlar quais ferramentas seu cliente vê; isso não altera suas permissões. O envio de arquivos locais exige stdio e não está disponível por HTTP. Defina SOSOAPI_OUTPUT_SCHEMAS=1 para incluir schemas de saída na descoberta. As ferramentas retornam resultados estruturados com ou sem essa configuração.

Permissões e efeitos colaterais

As anotações ajudam os clientes a descrever uma ferramenta. Cada chamada ainda verifica autenticação, função, acesso a recursos e concessões de capacidades do usuário.

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

/studio-api/projects/list: agent:operate · synchronous_http_response

Campos de entrada

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Campos de entrada
Campo / ramificação	Tipo / obrigatório	Restrições
`$`	`object`Obrigatório no objeto pai	`additionalProperties: false`
`workspace_id`	`string`Obrigatório no objeto pai	`format: "uuid"`
`limit`	`integer`Opcional / item	Tamanho da página, de 1 a 100. Enviar limit ou cursor muda esta rota para paginação por cursor e adiciona next_cursor à resposta. `minimum: 1` `maximum: 100`
`cursor`	`string`Opcional / item	Cursor opaco: o next_cursor da página anterior, sem alterações. Omita-o na primeira página. Os mesmos filtros devem ser enviados em todas as páginas. `minLength: 1` `maxLength: 512`
`include_version`	`boolean`Opcional / item	Opcional. true adiciona a versão do recurso à resposta. —

JSON Schema completo

{
  "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
}

Saída estruturada

Este schema descreve structuredContent em um resultado de ferramenta bem-sucedido. A resposta MCP também inclui content e pode definir isError quando uma chamada falha. Para publicações, consulte o resultado final do post em vez de tratar uma requisição aceita ou resposta de texto como confirmação. A operação de API vinculada explica as permissões e regras de repetição.

Saída estruturada
Campo / ramificação	Tipo / obrigatório	Restrições
`$`	`object`Obrigatório no objeto pai	`additionalProperties: false`
`projects`	`array`Obrigatório no objeto pai	—
`projects[]`	`object`Opcional / item	`additionalProperties: false`
`projects[].id`	`string`Obrigatório no objeto pai	`format: "uuid"`
`projects[].workspace_id`	`string`Obrigatório no objeto pai	`format: "uuid"`
`projects[].name`	`string`Obrigatório no objeto pai	`minLength: 1` `maxLength: 200`
`projects[].operational_state`	`string`Obrigatório no objeto pai	`enum: ["active","archived"]`
`projects[].lifecycle_version`	`integer`Obrigatório no objeto pai	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`projects[].defaults_version`	`integer`Obrigatório no objeto pai	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`projects[].archived_at`	`string \| null`Obrigatório no objeto pai	—
`projects[].archived_at`anyOf 1	`string`Obrigatório no objeto pai	—
`projects[].archived_at`anyOf 2	`null`Obrigatório no objeto pai	—
`projects[].archived_by`	`string \| null`Obrigatório no objeto pai	—
`projects[].archived_by`anyOf 1	`string`Obrigatório no objeto pai	`format: "uuid"`
`projects[].archived_by`anyOf 2	`null`Obrigatório no objeto pai	—
`projects[].archived_by_api_key_id`	`string \| null`Obrigatório no objeto pai	—
`projects[].archived_by_api_key_id`anyOf 1	`string`Obrigatório no objeto pai	`format: "uuid"`
`projects[].archived_by_api_key_id`anyOf 2	`null`Obrigatório no objeto pai	—
`projects[].created_at`	`string`Obrigatório no objeto pai	—
`projects[].updated_at`	`string`Obrigatório no objeto pai	—
`projects[].version`	`integer`Opcional / item	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`active_project_id`	`string \| null`Obrigatório no objeto pai	—
`active_project_id`anyOf 1	`string`Obrigatório no objeto pai	`format: "uuid"`
`active_project_id`anyOf 2	`null`Obrigatório no objeto pai	—
`next_cursor`	`string \| null`Opcional / item	Presente apenas quando a requisição envia limit ou cursor. Null na última página. —
`next_cursor`anyOf 1	`string`Opcional / item	—
`next_cursor`anyOf 2	`null`Opcional / item	—

JSON Schema completo

{
  "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
}

Exemplo de chamada de ferramenta

Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.

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

structuredContent

{
  "projects": [],
  "active_project_id": null
}

/studio-api/projects/list

Instale ou conecte MCP