Skip to main content
Glama

List firewall rules

list_firewall_rules
Read-onlyIdempotent

List the firewall rules of this environment: which inbound ports its machines accept, over TCP or UDP, and from which addresses (sources). Everything else is closed. A new environment allows only SSH (port 22) from anywhere. Changes reach running machines within about a minute. A machine started before the firewall existed shows firewall.status "unmanaged" in get_instance and keeps its ports as they were until it is started again. An HTTPS link to a web app on an instance is create_instance_link, not a firewall rule.

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": "list_firewall_rules"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceNoWorkspace ID (optional: defaults to the authenticated workspace)
environmentNoEnvironment name (optional: defaults to the environment this session acts in)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / properties / env
      Removed value: -{
      -  "description": "Environment name (optional — defaults to main)",
      -  "type": "string"
      -}
    • addedInput schema / properties / environment
      Added value: +{
      +  "description": "Environment name (optional: defaults to the environment this session acts in)",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspace / description
      Previous value: -"Workspace ID (optional — defaults to authenticated workspace)"New value: +"Workspace ID (optional: defaults to the authenticated workspace)"
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description still adds substantial behavior: the default state (only SSH/22 from anywhere), a ~1 minute propagation delay to running machines, and the "unmanaged" firewall.status shown in get_instance for machines started before the firewall existed. That last point is exactly the kind of caveat that prevents an agent from misinterpreting empty or stale results.

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?

Four sentences, front-loaded with purpose, then behavior, then the disambiguation. Every sentence carries information, though the propagation-delay and unmanaged-status details are packed densely into a single description rather than separated visually.

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?

There is no output schema, and the description compensates by describing the shape of a rule (ports, protocol, sources) plus edge cases around defaults and stale machines. For a two-optional-parameter read tool with full annotation coverage, nothing an agent needs to call or interpret it is missing.

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 both parameters (workspace, environment) already document that they default to the authenticated workspace and session environment. The description adds no further semantics about these parameters, 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 and resource ("List the firewall rules of this environment") and immediately defines what a rule contains — inbound ports, TCP/UDP protocol, and source addresses. It is unambiguously distinguishable from the sibling mutators add_firewall_rule, update_firewall_rule, and remove_firewall_rule.

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?

Provides real usage context: "Everything else is closed" tells the agent this listing fully describes the allowed inbound surface, and it explicitly routes a common misread ("An HTTPS link to a web app on an instance is create_instance_link, not a firewall rule") to the correct sibling. It stops short of stating the inverse workflow (e.g. use add_firewall_rule to open a port), so it is strong but not exhaustive.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.