Show progress of a workflow

How far a workflow is that another route started, by its workflow_token.

RReadIdempotentbeta

Tool

manitu_workflow_geton https://mcp.manitu.de/mcp

POST

/v1/workflow/geton https://api.manitu.de

Try it

Annotations as tools/list sends them

readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

Description for the model

Tells how far a workflow is that a manitu tool started in the manitu customer account this connection works in - a restart or snapshot of a virtual server, a database copy and the like - by the workflow_token that tool answered, passed as it is. status pending or running: not done yet - wait and ask again, not more often than about once a minute; some take many minutes. done: finished. error: it failed - tell the customer, do not simply start it again (result.error_list may say why). result has what it left for the customer once finished - an installed application's administrator and where to log in, the versions of an update. Refused (forbidden) when this access may not see the package or server the workflow works on. The token is a secret of this workflow: never show it.

Arguments

workflow_tokenstringrequiredwrite-only

The workflow_token the starting tool answered - passed as it is, never built.

min length 1max length 255

Result structuredContent, checked against the schema

workflowstring | nullrequired

What is being done, e.g. power_reboot or ngcobalt_site_web_database_copy.

One of create destroy power_start power_stop power_reboot reinstall ptr_set vnc_enable vnc_disable rescuesystem_enable rescuesystem_disable snapshot_create snapshot_delete snapshot_delete_all snapshot_revert telemetry_await iso_eject none account_contract_termination_finish ngcobalt_site_web_application_installation_set ngcobalt_site_web_application_installation_update ngcobalt_site_web_permission_set ngcobalt_site_web_database_copy network_librenms_discover null

workflow_idstring | nullrequired

The id of this run, as vserver/workflow/list names it; null for a workflow not kept as tasks.

statusstringrequired

pending: waiting to start; running: started, not finished (can take a while); done: finished, everything went through; error: finished, but it or part of it failed.

One of pending running done error

created_atstring | nullrequired

When it was asked for.

Format date-time

started_atstring | nullrequired

When it started; null while pending, and for a workflow that does not record it.

Format date-time

ended_atstring | nullrequired

When it finished; null until then.

Format date-time

updated_atstring | nullrequired

When it last changed.

Format date-time

resultobject | nullrequired

What it left for the customer, when it is finished - null for a workflow that keeps none.

result.adminobject | nullrequired

The administrator of an application manitu installed.

result.admin.usernamestringrequired

result.admin.passwordstring | nullrequired

A secret; null where it is withheld (secrets_withheld).

result.admin.mail_addressstringrequired

result.administration_urlstring | nullrequired

Where an installed application is administered.

result.versionobject | nullrequired

The versions of an application update.

result.version.oldstring | nullrequired

result.version.newstring | nullrequired

result.dumpobject | nullrequired

The dump files a database copy wrote, relative to the package.

result.dump.sourcestring | nullrequired

result.dump.targetstring | nullrequired

result.error_listarray of stringrequired

Why it failed, as codes - e.g. quota_exceeded, extra_files_found, nextcloud_too_old.

secrets_withheldbooleanrequired

A secret in result is left out here (an answer to an agent).

Authentication

One of X-API-Key, Authorization: Bearer … - never more than one in a request. More

Request body JSON; unknown fields are refused

workflow_tokenstringrequiredwrite-only

The workflow_token the starting tool answered - passed as it is, never built.

min length 1max length 255

Response in `data`; the rest of the body as on every call

workflowstring | nullrequired

What is being done, e.g. power_reboot or ngcobalt_site_web_database_copy.

workflow_idstring | nullrequired

The id of this run, as vserver/workflow/list names it; null for a workflow not kept as tasks.

statusstringrequired

pending: waiting to start; running: started, not finished (can take a while); done: finished, everything went through; error: finished, but it or part of it failed.

One of pending running done error

created_atstring | nullrequired

When it was asked for.

Format date-time

started_atstring | nullrequired

When it started; null while pending, and for a workflow that does not record it.

Format date-time

ended_atstring | nullrequired

When it finished; null until then.

Format date-time

updated_atstring | nullrequired

When it last changed.

Format date-time

resultobject | nullrequired

What it left for the customer, when it is finished - null for a workflow that keeps none.

result.adminobject | nullrequired

The administrator of an application manitu installed.

result.admin.usernamestringrequired

result.admin.passwordstring | nullrequired

A secret; null where it is withheld (secrets_withheld).

result.admin.mail_addressstringrequired

result.administration_urlstring | nullrequired

Where an installed application is administered.

result.versionobject | nullrequired

The versions of an application update.

result.version.oldstring | nullrequired

result.version.newstring | nullrequired

result.dumpobject | nullrequired

The dump files a database copy wrote, relative to the package.

result.dump.sourcestring | nullrequired

result.dump.targetstring | nullrequired

result.error_listarray of stringrequired

Why it failed, as codes - e.g. quota_exceeded, extra_files_found, nextcloud_too_old.

secrets_withheldbooleanrequired

A secret in result is left out here (an answer to an agent).

Statuses

200Success.400The request does not match the declared input schema.401No credential was presented, or it was not recognised.403The credential is not permitted to use this operation.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.

MCPtools/call

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "manitu_workflow_get",
    "arguments": {
      "workflow_token": "eyJwYWdlIjoyfQ"
    }
  }
}

Result

{
  "structuredContent": {
    "workflow": "create",
    "workflow_id": "string",
    "status": "pending",
    "created_at": "2026-10-23T12:00:00+02:00",
    "started_at": "2026-10-23T12:00:00+02:00",
    "ended_at": "2026-10-23T12:00:00+02:00",
    "updated_at": "2026-10-23T12:00:00+02:00",
    "result": {
      "admin": {
        "username": "string",
        "password": "correct-horse-battery",
        "mail_address": "info@example.com"
      },
      "administration_url": "https://www.example.com/",
      "version": {
        "old": "string",
        "new": "string"
      },
      "dump": {
        "source": "string",
        "target": "string"
      },
      "error_list": [
        "string"
      ]
    },
    "secrets_withheld": true
  },
  "content": [
    {
      "type": "text",
      "text": "… the same answer as text …"
    }
  ],
  "isError": false
}

POST/v1/workflow/get

Request

curl -X POST 'https://api.manitu.de/v1/workflow/get' \
  -H 'X-API-Key: $API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "workflow_token": "eyJwYWdlIjoyfQ"
  }'

const response = await fetch('https://api.manitu.de/v1/workflow/get', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "workflow_token": "eyJwYWdlIjoyfQ"
  }),
});
const answer = await response.json();

<?php

$curl = curl_init('https://api.manitu.de/v1/workflow/get');

curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'X-API-Key: ' . getenv('API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => '{"workflow_token":"eyJwYWdlIjoyfQ"}',
    CURLOPT_RETURNTRANSFER => true,
]);

$answer = json_decode(curl_exec($curl), true);

import os

import requests

response = requests.request(
    "POST",
    "https://api.manitu.de/v1/workflow/get",
    headers={"X-API-Key": os.environ["API_KEY"]},
    json={
        "workflow_token": "eyJwYWdlIjoyfQ",
    },
)
answer = response.json()

Response 200

{
  "status": {
    "type": "success",
    "code": 200
  },
  "meta": {},
  "data": {
    "workflow": "create",
    "workflow_id": "string",
    "status": "pending",
    "created_at": "2026-10-23T12:00:00+02:00",
    "started_at": "2026-10-23T12:00:00+02:00",
    "ended_at": "2026-10-23T12:00:00+02:00",
    "updated_at": "2026-10-23T12:00:00+02:00",
    "result": {
      "admin": {
        "username": "string",
        "password": "correct-horse-battery",
        "mail_address": "info@example.com"
      },
      "administration_url": "https://www.example.com/",
      "version": {
        "old": "string",
        "new": "string"
      },
      "dump": {
        "source": "string",
        "target": "string"
      },
      "error_list": [
        "string"
      ]
    },
    "secrets_withheld": true
  }
}

Show progress of a workflow

Annotations as tools/list sends them

Description for the model

Arguments

Result structuredContent, checked against the schema

Authentication

Request body JSON; unknown fields are refused

Response in data; the rest of the body as on every call

Statuses

Response in `data`; the rest of the body as on every call