Skip to main content
Glama

skycloak_list_openfga_instances

Read-only

List OpenFGA instances bound to a cluster's realms and see each one's status—provisioning, ready, failed, or deleting—even if the workspace lost OpenFGA access.

Instructions

List the OpenFGA instances bound to a cluster's realms, with each one's status (provisioning, ready, failed or deleting). Works on every plan, so a workspace that lost OpenFGA access still sees what it has.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "cluster_id": "<cluster_id>"
    },
    "name": "skycloak_list_openfga_instances"
  }
}

Input Schema

NameRequiredDescriptionDefault
cluster_idYesthe cluster whose OpenFGA instances to list

Output Schema

NameRequiredDescriptionDefault
countYes
instancesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already cover read-only and closed-world behavior, and the description adds the reachable status set (provisioning, ready, failed, deleting) so the agent knows results include non-ready instances. It also discloses the entitlement-independent behavior, which is non-obvious from structured fields alone; only pagination or result-shape notes are missing.

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?

Two short sentences with no wasted wording: the resource and scope come first, followed by a single high-value caveat about plan availability. Every sentence earns its place.

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 an output schema, annotations, and full parameter coverage, the description only needs to add the non-structural nuances, and it does so via status values and the plan/entitlement note. Nothing critical for correct invocation appears to be 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 there is a single required cluster_id, so the schema already carries the parameter meaning. The description mentions the cluster binding but adds no format or constraint detail beyond what the schema provides, making the baseline 3 appropriate.

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 description states a specific verb and resource ('List the OpenFGA instances') plus a clear scope ('bound to a cluster's realms'), which reads distinctly from get/create/delete OpenFGA instance siblings. It stops short of naming an alternative tool, but the list-vs-single distinction is still easy to infer.

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?

The second sentence gives a real usage condition: it works on every plan, so a workspace that lost OpenFGA access can still enumerate instances. That is a useful when-to-use signal, though there is no explicit guidance on when to prefer get_openfga_instance for detail.

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