Skip to main content
Glama
RMITBLOG

Parallels RAS MCP Server

by RMITBLOG

Gateway Status

ras_infra_get_gateway_status
Read-onlyIdempotent

Retrieve RAS Secure Client Gateway status details, including connection state, IP addresses, and tunnel mode, to monitor gateway health and troubleshoot external user connectivity.

Instructions

Status of RAS Secure Client Gateways — connection state, IP addresses, tunnel mode. Gateways provide external user access to published resources. Use this to monitor gateway health or troubleshoot external connectivity.

Input Schema

NameRequiredDescriptionDefault
limitNoMax rows after filtering. Default 50, max 200. Prefer narrowing with `filter` over raising the limit.
fieldsNoTop-level keys to keep on each row. Unknown keys are dropped. Use this to shrink large responses to only the columns you need.
filterNoEquality filter on top-level fields (AND across keys). String values match case-insensitively.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.3.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / fields
      Added value: +{
      +  "description": "Top-level keys to keep on each row. Unknown keys are dropped. Use this to shrink large responses to only the columns you need.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / filter
      Added value: +{
      +  "additionalProperties": {
      +    "type": [
      +      "string",
      +      "number",
      +      "boolean"
      +    ]
      +  },
      +  "description": "Equality filter on top-level fields (AND across keys). String values match case-insensitively.",
      +  "type": "object"
      +}
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Max rows after filtering. Default 50, max 200. Prefer narrowing with `filter` over raising the limit.",
      +  "maximum": 200,
      +  "minimum": 1,
      +  "type": "integer"
      +}
  2. First observedv1.0.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and openWorld, so the safety profile is covered. The description adds field-level context (what a "status" actually contains) and the role gateways play, but says nothing about volume, pagination, or how the limit/filter interplay works beyond what the schema documents.

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

Conciseness5/5

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

Three short sentences with the returned fields front-loaded and the usage hint last. The middle sentence about gateways providing external access is brief but earns its place by disambiguating the resource.

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

Completeness5/5

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

For a read-only informational tool with no output schema, the description names the returned data, so an agent knows roughly what comes back. Annotations carry safety and the schema carries paging/filtering, leaving no meaningful gap.

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?

Schema description coverage is 100% and all three parameters (limit, fields, filter) are thoroughly documented in the schema with defaults, bounds, and guidance. The description adds no additional parameter meaning, so the baseline 3 applies.

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+resource (gateway status) and enumerates exactly what the status contains: connection state, IP addresses, tunnel mode. It is clearly distinguishable from neighboring infrastructure status tools such as ras_infra_get_halb_status or ras_infra_get_enrollment_status.

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?

"Use this to monitor gateway health or troubleshoot external connectivity" gives explicit operational context for when to reach for it. It stops short of naming alternatives or when-not to use it, but the intent is unambiguous.

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