get_platform_status

Pack: pipeworx-catalog · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/get_platform_status for the schema, then POST the same URL with its arguments for the data.

Check Pipeworx platform health and availability. Returns pack count, active tool count, and any service alerts. Use to verify system status before operations.

Example call

Arguments

{}

curl

curl -X POST https://gateway.pipeworx.io/pipeworx-catalog/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_platform_status","arguments":{}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('get_platform_status', {});

Response shape

Always returns: gateway, website, monitored_apis, live, degraded, down, overall_status

{
  "type": "object",
  "properties": {
    "gateway": {
      "type": "string",
      "description": "Pipeworx gateway URL"
    },
    "website": {
      "type": "string",
      "description": "Pipeworx website URL"
    },
    "monitored_apis": {
      "type": "number",
      "description": "Total number of monitored APIs"
    },
    "live": {
      "type": "number",
      "description": "Number of live APIs"
    },
    "degraded": {
      "type": "number",
      "description": "Number of degraded APIs"
    },
    "down": {
      "type": "number",
      "description": "Number of down APIs"
    },
    "overall_status": {
      "type": "string",
      "description": "Overall platform status"
    }
  },
  "required": [
    "gateway",
    "website",
    "monitored_apis",
    "live",
    "degraded",
    "down",
    "overall_status"
  ]
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}

{
  "mcpServers": {
    "pipeworx-catalog": {
      "url": "https://gateway.pipeworx.io/pipeworx-catalog/mcp"
    }
  }
}

See Getting Started for client-specific install steps.