Referência de Ferramentas MCP

Todas as ferramentas devolvem um array content de blocos de conteúdo MCP. Ferramentas de texto devolvem { type: "text", text: "<json-string>" }. Ferramentas de imagem devolvem { type: "image", data: "<base64>", mimeType: "image/png" }. Em caso de erro, isError: true é definido e o bloco de texto contém a mensagem de erro.

Ferramentas de ficheiros

`list-files`

Lista os ficheiros do Flowstep do utilizador atual. Entrada

Parâmetro	Tipo	Predefinição	Descrição
`orderByCreation`	`boolean`	`true`	Ordenar por data de criação
`limit`	`integer` (1–100)	`20`	Número de ficheiros a devolver
`offset`	`integer` (≥0)	`0`	Offset de paginação

Saída — Array JSON de objetos de ficheiro.

[
  {
    "id": "5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0",
    "name": "Dashboard redesign",
    "created_at": "2026-04-30T15:02:13.120152+00:00",
    "updated_at": "2026-04-30T15:02:13.120152+00:00",
    "owner": true,
    "url": "https://app.flowstep.ai/file?activeFileId=5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0"
  }
]

`get-file`

Obtém um único ficheiro por ID. O conteúdo do ficheiro é propositalmente omitido — use get-screen ou get-screen-image para inspecionar ecrãs, e get-design-guidelines para recuperar as diretrizes anexadas. Entrada

Parâmetro	Tipo	Descrição
`id`	`uuid`	ID do ficheiro

Saída — Objeto JSON do ficheiro.

{
  "file": {
    "id": "5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0",
    "name": "Dashboard redesign",
    "project_id": "81cb84d6-c69f-492c-a895-7421b60d1a6d",
    "created_at": "2026-04-30T15:02:13.120152+00:00",
    "updated_at": "2026-04-30T15:02:13.120152+00:00",
    "access_level": "private",
    "owner": true,
    "url": "https://app.flowstep.ai/file?activeFileId=5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0"
  },
  "user_access_level": "write"
}

`create-file`

Cria um novo ficheiro do Flowstep. Entrada

Parâmetro	Tipo	Descrição
`title`	`string` (min 1)	Nome do ficheiro

Saída — Objeto JSON do ficheiro com o id do novo ficheiro.

{
  "id": "5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0",
  "name": "Dashboard redesign",
  "project_id": "81cb84d6-c69f-492c-a895-7421b60d1a6d",
  "created_at": "2026-04-30T15:02:13.120152+00:00",
  "updated_at": "2026-04-30T15:02:13.120152+00:00",
  "access_level": "private",
  "user_access_level": "write",
  "owner": true,
  "url": "https://app.flowstep.ai/file?activeFileId=5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0"
}

Use o id devolvido como fileId em chamadas de ferramentas subsequentes.

`update-file`

Renomeia um ficheiro. Entrada

Parâmetro	Tipo	Descrição
`id`	`uuid`	ID do ficheiro
`name`	`string` (min 1)	Novo nome

Saída — Objeto de ficheiro atualizado na mesma forma que get-file.

{
  "file": {
    "id": "5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0",
    "name": "Dashboard redesign (v2)",
    "project_id": "81cb84d6-c69f-492c-a895-7421b60d1a6d",
    "created_at": "2026-04-30T15:02:13.120152+00:00",
    "updated_at": "2026-04-30T15:02:13.120152+00:00",
    "access_level": "private",
    "owner": true,
    "url": "https://app.flowstep.ai/file?activeFileId=5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0"
  },
  "user_access_level": "write"
}

`delete-file`

Elimina permanentemente um ficheiro. O name que passa é verificado contra o nome real do ficheiro antes da eliminação — se não corresponder, a eliminação é abortada. Isto evita eliminar acidentalmente o ficheiro errado. Entrada

Parâmetro	Tipo	Descrição
`id`	`uuid`	ID do ficheiro
`name`	`string`	Nome atual do ficheiro — deve corresponder exatamente ou a eliminação é abortada

Saída — "File deleted successfully"

Isto é irreversível. Todos os ecrãs no ficheiro são eliminados.

Ferramentas de ecrã

`list-screens`

Lista todos os ecrãs gerados para um ficheiro. Use os valores screenId devolvidos para referenciar ecrãs em get-screen, get-screen-image, upload-attachment, e como targets em edit-design, regenerate-design, ou expand-design. Entrada

Parâmetro	Tipo	Descrição
`fileId`	`uuid`	ID do ficheiro

Saída — Array JSON de resumos de ecrã.

[
  {
    "screenId": "3f9e6eb6-5525-4383-9375-67e0bd762dbe",
    "name": "Mobile login screen",
    "fidelity": "ui",
    "prompt": "Generate a simple mobile login screen with email and password fields and a sign in button",
    "createdAt": "2026-04-30T15:02:37.444139+00:00"
  }
]

name é o nome do ecrã atribuído pelo utilizador, ou null se não tiver nome.

`get-screen`

Obtém o código JSX de um ecrã permitindo-lhe editar ou usar o código fora do Flowstep. Use get-screen-image para uma pré-visualização visual. Entrada

Parâmetro	Tipo	Descrição
`fileId`	`uuid`	ID do ficheiro
`screenId`	`uuid`	O `screenId` devolvido por `list-screens` ou do array `screenIds` devolvido por uma ferramenta de design

Saída — O ecrã como código (JSX). Note o comentário da primeira linha que é necessário ao usar a ferramenta add-screen.

<!-- screenType: "iphone-x-vertical" width: "375" height: "812" name: "Change to a light theme" colorTheme: "blue" screenId: "c13d3707-0efe-49f5-b6cb-0ca5ac5223d0" -->
<div className="bg-white text-zinc-950 w-full h-fit">
  <div className="flex p-6 flex-col gap-6">
    <div className="flex pt-4 justify-between items-center">
      <ArrowLeft className="size-5 text-[#71717b]" />
      <span className="font-semibold text-zinc-950 text-lg leading-7">
        World Clock
      </span>
      <Plus className="size-5 text-[#2b7fff]" />
    </div>
    <div className="rounded-xl bg-zinc-100 flex p-2 items-center gap-2">
      <Search className="size-4 text-[#71717b] ml-2" />
      <span className="text-[#71717b] text-sm leading-5">Search cities...</span>
    </div>
...
    <div className="flex pt-2 pb-4 justify-center items-center gap-4">
      <Button variant="outline" className="rounded-full px-6 gap-2">
        <Clock className="size-4" />
        <span>Compare</span>
      </Button>
      <Button className="rounded-full bg-[#2b7fff] text-blue-50 px-6 gap-2">
        <Bell className="size-4" />
        <span>Set Alert</span>
      </Button>
    </div>
  </div>
</div>;

`add-screen`

Adiciona um novo ecrã a um ficheiro do Flowstep a partir de uma string JSX bruta. Entrada

Parâmetro	Tipo	Descrição
`fileId`	`uuid`	ID do ficheiro
`jsxContent`	`string`	JSX a adicionar ao ficheiro como um ecrã
`screenType`	`string`	Obrigatório se o tipo de ecrã não estiver definido como comentário no início do JSX

Nota — Um comentário semelhante ao abaixo DEVE estar presente como a primeira linha do JSX pois é usado para adicionar o ecrã corretamente. screenType, name, e screenId são todos opcionais — screenId é usado (internamente) se presente (por exemplo, ao passar JSX copiado de saída get-screen) mas não é obrigatório. O nome do ecrã é retirado do campo name do comentário (apresentado como “Copy of <name>”), ou “Untitled” se ausente.  Saída — O ID do ecrã recém-adicionado.

{ "screenId": "3f9e6eb6-5525-4383-9375-67e0bd762dbf" }

`get-screen-image`

Renderiza um ecrã para PNG e devolve-o como uma imagem inline. Requer um cliente que suporte blocos de conteúdo de imagem. Entrada

Parâmetro	Tipo	Descrição
`fileId`	`uuid`	ID do ficheiro
`screenId`	`uuid`	O `screenId` devolvido por `list-screens` ou do array `screenIds` devolvido por uma ferramenta de design

Saída — Bloco de conteúdo de imagem MCP (image/png).

Ferramentas de IA

regenerate-design, expand-design, e edit-design requerem contexto de design que só está presente em ecrãs originalmente gerados com um array designs. Ecrãs gerados sem contexto de design devolverão um erro. Solução alternativa: use upload-attachment para renderizar o ecrã como uma imagem, depois chame create-new-design com a imagem em attachments e uma mensagem descrevendo as alterações desejadas.

`create-new-design`

Gera um ou mais designs de ecrã a partir de um prompt de texto. Omita fileId para criar um novo ficheiro automaticamente. Bloqueia até que a geração se conclua ou expire (180 segundos). Entrada

Parâmetro	Tipo	Predefinição	Descrição
`fileId`	`uuid`	—	Ficheiro de destino — omita para criar um novo ficheiro automaticamente
`message`	`string`	—	Prompt descrevendo os ecrãs a gerar
`attachments`	`AttachmentRequestData[]` (máx 5)	`[]`	Anexos pré-carregados — imagens, PDFs ou ficheiros de código. Sempre carregue via `upload-attachment` primeiro; não inline conteúdo de ficheiro na mensagem
`designs`	`DesignRequestData[]`	`[]`	Referências de design

Saída — { fileId, screenIds }. Passe cada screenId para get-screen-image para ver resultados.

{
  "fileId": "5c2170f0-5b09-4a5a-ba7a-4d5c2cfb07e0",
  "screenIds": ["3f9e6eb6-5525-4383-9375-67e0bd762dbe"]
}

`regenerate-design`

Refaz ecrãs existentes do zero ou com uma variação de estilo. Requer pelo menos um screenId em targets. Bloqueia até que a geração se conclua ou expire (180 segundos). Entrada

Parâmetro	Tipo	Predefinição	Descrição
`fileId`	`uuid`	—	Ficheiro de destino
`message`	`string`	—	Texto do prompt
`targets`	`uuid[]` (min 1)	—	screenIds de ecrãs a regenerar
`operationVariant`	`"different_layout" \| "different_style" \| "from_scratch"`	—	Variante de estilo opcional
`designs`	`DesignRequestData[]`	`[]`	Referências de design (resolvidas automaticamente)

Saída — { fileId, screenIds }. Passe cada screenId para get-screen-image para ver resultados.

`expand-design`

Adiciona ecrãs de acompanhamento a um design existente. Requer pelo menos um screenId em targets e um operationVariant obrigatório. Bloqueia até que a geração se conclua ou expire (180 segundos). Entrada

Parâmetro	Tipo	Predefinição	Descrição
`fileId`	`uuid`	—	Ficheiro de destino
`message`	`string`	—	Texto do prompt
`targets`	`uuid[]` (min 1)	—	screenIds de ecrãs a expandir
`operationVariant`	`"next_screen" \| "error_state" \| "empty_state" \| "web_version" \| "mobile_version" \| "tablet_version" \| "mobile_ios_version" \| "mobile_android_version"`	—	Obrigatório — tipo de ecrã de acompanhamento a gerar
`designs`	`DesignRequestData[]`	`[]`	Referências de design (resolvidas automaticamente)

Saída — { fileId, screenIds }. Passe cada screenId para get-screen-image para ver resultados.

`edit-design`

Modifica ecrãs existentes via um prompt. Requer pelo menos um screenId em targets. Bloqueia até que a geração se conclua ou expire (180 segundos). Entrada

Parâmetro	Tipo	Predefinição	Descrição
`fileId`	`uuid`	—	Ficheiro de destino
`message`	`string`	—	Instruções descrevendo as edições a aplicar
`targets`	`uuid[]` (min 1)	—	screenIds de ecrãs a editar
`operationVariant`	`"dark_theme" \| "light_theme" \| "make_pretty"`	—	Atalho de estilo opcional
`attachments`	`AttachmentRequestData[]` (máx 5)	`[]`	Anexos pré-carregados. Sempre carregue via `upload-attachment` primeiro
`designs`	`DesignRequestData[]`	`[]`	Referências de design (resolvidas automaticamente)

Saída — { fileId, screenIds }. Passe cada screenId para get-screen-image para ver resultados.

`upload-attachment`

Carrega um ficheiro para usar como anexo em create-new-design ou edit-design. Devolve { id, path, type, mimeType } — passe este objeto diretamente no array attachments. Dois modos: Modo 1 — Ecrã por ID Passe screenId e fileId. O servidor obtém o estado do ecrã da base de dados e renderiza-o como uma imagem.

Parâmetro	Tipo	Descrição
`fileId`	`uuid`	Ficheiro contendo o ecrã (obrigatório)
`screenId`	`uuid`	Ecrã a renderizar

Modo 2 — Ficheiro externo Passe conteúdo de ficheiro diretamente. Ficheiros binários devem ser codificados em base64; ficheiros de texto (incluindo código-fonte) são passados como strings UTF-8 simples.

Parâmetro	Tipo	Descrição
`fileData`	`string`	Conteúdo do ficheiro — base64 para binário, string UTF-8 para texto
`fileName`	`string`	Nome do ficheiro original
`mimeType`	`"image/jpeg" \| "image/png" \| "image/webp" \| "application/pdf" \| "text/plain" \| "text/javascript"`	Tipo MIME. Use `text/javascript` para ficheiros `.jsx`, `.tsx`, `.js`, `.ts`

Tamanho máximo do ficheiro: 3 MB. Para imagens grandes, prefira image/jpeg em vez de image/png. Saída

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "path": "attachments/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "image",
  "mimeType": "image/jpeg"
}

type é "image" para uploads de imagem/PDF e "document" para ficheiros de texto/código.

Ferramentas de chat

`get-chat-history`

Obtém o histórico de mensagens de chat de um ficheiro. Entrada

Parâmetro	Tipo	Descrição
`fileId`	`uuid`	ID do ficheiro

Saída — Objeto JSON com um array messages. Cada mensagem tem um type ("request" ou "response"), author ("human" ou "ai"), e content_type ("text", "summary", ou "followup").

{
  "messages": [
    {
      "id": "453f593d-2380-425b-ba29-127db08d6a8e",
      "chat_id": "146d0f19-497e-450c-ba53-3de15f6bd70b",
      "type": "request",
      "status": "success",
      "content": "Generate a simple mobile login screen with email and password fields",
      "author": "human",
      "content_type": "text",
      "sequence": 1,
      "request_message_id": null,
      "targets": [],
      "attachments": []
    },
    {
      "id": "d860186b-82d5-4bd1-8e8e-8ba5377a14bf",
      "chat_id": "146d0f19-497e-450c-ba53-3de15f6bd70b",
      "type": "response",
      "status": "success",
      "content": "Generated a mobile login screen with email and password input fields, sign in button, remember me checkbox, forgot password link, social login options (Apple/Google), and sign up link.",
      "author": "ai",
      "content_type": "summary",
      "sequence": 7,
      "request_message_id": "453f593d-2380-425b-ba29-127db08d6a8e",
      "targets": [{ "target_id": "3f9e6eb6-5525-4383-9375-67e0bd762dbe" }],
      "attachments": []
    }
  ]
}

Ferramentas de design

`get-design-guidelines`

Obtém as diretrizes de design armazenadas para um ficheiro. Entrada

Parâmetro	Tipo	Predefinição	Descrição
`resourceId`	`uuid`	—	ID do ficheiro
`linkedTo`	`"file"`	`"file"`	Tipo de recurso

Saída

{
  "guidelines": "## Colors\n\nPrimary: #6366F1\nBackground: #FFFFFF\n\n## Typography\n\nFont: Inter",
  "linkedTo": "file"
}

guidelines é null se nenhuma diretriz tiver sido definida.

`update-design-guidelines`

Define ou substitui as diretrizes de design para um ficheiro. As diretrizes são passadas como uma string de texto simples no formato design.md do Google — não passe um objeto ou JSON. O servidor realiza validação suave e pode devolver uma secção Warnings: na resposta listando problemas (chaves desconhecidas, cores não-hex) que foram aceitos mas podem ser ignorados pela IA. Apresente-os ao utilizador. Entrada

Parâmetro	Tipo	Predefinição	Descrição
`resourceId`	`uuid`	—	ID do ficheiro
`designGuidelines`	`string` (min 1)	—	Conteúdo de texto bruto das diretrizes. Deve ser uma string simples — não codificado em JSON
`linkedTo`	`"file"`	`"file"`	Tipo de recurso

Regras de validação

Frontmatter deve ser aberto e fechado corretamente
Linhas de frontmatter devem ser YAML válido no estilo de bloco
Corpo Markdown não deve conter cabeçalhos de secção ## duplicados

Saída — "Design guidelines updated successfully", opcionalmente seguido de uma secção Warnings:.

`delete-design-guidelines`

Limpa as diretrizes de design para um ficheiro. Entrada

Parâmetro	Tipo	Predefinição	Descrição
`resourceId`	`uuid`	—	ID do ficheiro
`linkedTo`	`"file"`	`"file"`	Tipo de recurso

Saída — "Design guidelines deleted successfully"

Ferramentas de faturação

`get-plan-details`

Obtém o plano atual do utilizador, estado da subscrição e quota restante. Não requer entrada. Saída

{
  "plan": {
    "name": "Starter",
    "code": "starter",
    "type": "paid"
  },
  "subscription": {
    "isPaid": true,
    "isTrial": false,
    "startDate": "2025-01-01T00:00:00Z",
    "endDate": null,
    "trialDaysRemaining": null
  },
  "limits": {
    "messages": {
      "daily": { "max": 50, "warn": 40 },
      "monthly": { "max": 500, "warn": 400 },
      "unlimited": false
    }
  },
  "usage": {
    "messages": { "daily": 12, "monthly": 87 }
  },
  "remaining": {
    "messages": { "daily": 38, "monthly": 413 }
  }
}

Os limites variam por plano. Chame esta ferramenta antes de um lote de gerações para verificar quota disponível.

​Ferramentas de ficheiros

​list-files

​get-file

​create-file

​update-file

​delete-file

​Ferramentas de ecrã

​list-screens

​get-screen

​add-screen

​get-screen-image

​Ferramentas de IA

​create-new-design

​regenerate-design

​expand-design

​edit-design

​upload-attachment

​Ferramentas de chat

​get-chat-history

​Ferramentas de design

​get-design-guidelines

​update-design-guidelines

​delete-design-guidelines

​Ferramentas de faturação

​get-plan-details

Ferramentas de ficheiros

`list-files`

`get-file`

`create-file`

`update-file`

`delete-file`

Ferramentas de ecrã

`list-screens`

`get-screen`

`add-screen`

`get-screen-image`

Ferramentas de IA

`create-new-design`

`regenerate-design`

`expand-design`

`edit-design`

`upload-attachment`

Ferramentas de chat

`get-chat-history`

Ferramentas de design

`get-design-guidelines`

`update-design-guidelines`

`delete-design-guidelines`

Ferramentas de faturação

`get-plan-details`