Skip to main content
Glama
FortiManager MCP Server

FortiManager MCP Server

by rstierli

get_ha_status

Retrieves FortiManager High Availability health status from /sys/ha/status, returning HA health details or errors to verify HA operation.

Instructions

Get FortiManager High Availability (HA) health.

Returns what FortiManager reports at /sys/ha/status. On a standalone unit that is the HA health alone, {"HA Health Status": "OK"} (measured on 7.6.8 and 8.0.2): no HA mode, no peer list and no primary/secondary role. The HA mode is in get_system_status, under "HA Mode".

Returns: dict: HA status with keys: - status: "success" or "error" - data: The HA status FortiManager returned - message: Error message if failed

Example: >>> result = await get_ha_status() >>> print(result["data"].get("HA Health Status"))

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

With no annotations, the description carries the burden and does disclose useful behavior: read-only fetch, standalone-unit output being just `{"HA Health Status": "OK"}` with no mode/peer/role, and version-specific observations (7.6.8, 8.0.2). It does not mention error conditions beyond a `message` key, auth requirements, or rate limits, so transparency is good but not comprehensive.

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

Conciseness4/5

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

Front-loaded with purpose and endpoint, then the standalone-unit caveat, then the sibling pointer. The Returns block and code example partially duplicate the output schema's job, adding some length, but each part remains scannable and on-topic.

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

Completeness4/5

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

An output schema exists, so the return-value detail is redundant-but-harmless; the description still adds real value by showing the minimal standalone payload and by naming where HA mode actually lives. Nothing critical is missing for a zero-parameter read tool.

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

Parameters4/5

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

The tool takes zero parameters and the example shows a no-argument invocation, so there is nothing to disambiguate. Baseline 4 applies; no parameter meaning is left unclear.

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

Purpose5/5

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

States a specific verb and resource ("Get FortiManager High Availability (HA) health") and pins down the exact endpoint `/sys/ha/status`. It also distinguishes itself from the closest sibling by noting that HA mode lives in get_system_status under "HA Mode", so an agent can choose correctly without opening another schema.

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

Usage Guidelines4/5

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

Gives a clear routing rule: use this for HA health, use get_system_status for HA Mode. It does not spell out explicit when-not conditions or prerequisites (e.g. no HA configured, permissions), but the single relevant alternative is named.

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