Skip to main content
Glama

Get a deployed app: spec, status, instances, URLs

flux_get_app
Read-only

Looks up any app on the network by name and returns its published specification, expiry, running instances, URLs and a reachability check: probes the shared domain (HTTP) and each instance port (TCP and HTTP) and explains what a 503 means, including when it is expected for non-web apps.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
portsNoPorts to probe on instances; needed for private apps whose ports are encrypted.
fluxIdPrivateKeyNoWIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key.
paymentPrivateKeyNoWIF private key of the Flux address that pays. Fund it with only what you intend to spend.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / ports
      Added value: +{
      +  "description": "Ports to probe on instances; needed for private apps whose ports are encrypted.",
      +  "items": {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  "type": "array"
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description goes beyond that by disclosing an active probing step (shared domain HTTP, per-instance TCP and HTTP), interpreting a 503, and noting it is expected for non-web apps — genuinely useful behavioral context an agent could not get from the annotations.

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?

A single front-loaded sentence that leads with the core action and enumerates the return contents; the probing and 503 detail are appended efficiently. It is dense but not padded.

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?

With no output schema, the description compensates by listing the returned fields and explaining the reachability payload, which is what an agent needs to interpret results. It omits any mention of the key-related parameters, but those are handled in the schema.

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 75%, so most parameters are already documented (ports for private apps, the two private keys). The description adds no parameter-level detail beyond the schema, so the baseline 3 is appropriate.

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 (looks up) and resource (any app on the network by name) plus the exact payload returned: spec, expiry, instances, URLs, and a reachability check. This clearly separates it from siblings like flux_get_app_logs, flux_get_app_stats, and flux_list_my_apps.

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

Usage Guidelines3/5

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

The phrase 'any app on the network by name' implies the lookup context, and the 503 explanation hints at diagnostic use, but there is no explicit when-to-use versus flux_get_app_stats or flux_list_my_apps, and no stated prerequisites. Usage is left to inference.

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.