Skip to main content
Glama

iaas_run_endpoint_health_check

Starts a cloud account health check for the specified cloud account ID to verify endpoint connectivity and service status. Use it to trigger manual or scheduled health validation.

Instructions

Starts cloud account health check Starts cloud account health check identified by its endpoint state POST /iaas/api/cloud-accounts/{id}/health-check

Input Schema

NameRequiredDescriptionDefault
idYesThe ID of the Cloud account (path)
apiVersionNoThe version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
periodicHealthCheckIdNoIf query param is provided then the endpoint health check is not started manually from the UI, but after a scheduled process.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.8/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare this is a non-read-only, non-idempotent, non-destructive write. The description adds only that it starts a check, without disclosing whether the operation is asynchronous, returns a request tracker, or what state the account must be in. Beyond the annotations, almost nothing is added.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short and the action is front-loaded, but the first and second lines are near-duplicates that restate the same action, wasting half the text. The raw HTTP route at the end is of limited value to an agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, and the description does not say what the call returns (request tracker, task ID, status) or how long the check takes. For an async-triggering operation, this leaves significant gaps an agent needs to interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the schema already documents id, apiVersion, and periodicHealthCheckId. The description only vaguely gestures at the id ('identified by its endpoint state') and says nothing about the manual versus scheduled semantics of periodicHealthCheckId, so it does not add meaning over the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first line states a specific verb and resource: starting a cloud account health check. It is distinguishable from the many sibling get_/delete_ cloud account tools since none of them trigger a health check. However, the second line's phrasing 'identified by its endpoint state' is awkward and obscures what the id actually identifies.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description never says when to use this tool versus alternatives, nor mentions prerequisites such as a valid existing cloud account or the distinction between manually triggered and scheduled health checks. The periodicHealthCheckId parameter implies a scheduled-vs-manual distinction that the description does not explain.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools