Skip to main content
Glama

skycloak_get_openfga_instance

Read-only

Retrieve a specific OpenFGA instance from a cluster to view its status, API URL, token issuer, and audience for calling it.

Instructions

Get one OpenFGA instance of a cluster, including its status and the API URL, token issuer and audience to call it with.

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>",
      "instance_id": "<instance_id>"
    },
    "name": "skycloak_get_openfga_instance"
  }
}

Input Schema

NameRequiredDescriptionDefault
cluster_idYesthe cluster the instance belongs to
instance_idYesthe OpenFGA instance ID

Output Schema

NameRequiredDescriptionDefault
idYes
realmYes
issuerYes
statusYes
api_urlYes
audienceYes
cluster_idYes
created_atYes
updated_atYes
status_messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful context about what the response contains (status, API URL, token issuer, audience), but that overlaps with the existing output schema and says nothing about permissions, error behavior, or whether the returned URL/audience are sensitive.

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?

A single front-loaded sentence with no filler: the action, the resource scope, and the returned payload are all stated immediately. Nothing could be removed without losing information.

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?

For a two-parameter read tool with full schema coverage, annotations, and an output schema, the description covers purpose and payload adequately. It could go slightly further by noting when to prefer the list tool or what happens with invalid IDs, but nothing essential to invoking it correctly 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%, so both cluster_id and instance_id are already documented in the schema. The description's 'of a cluster' reinforces the cluster_id relationship but adds no format, identifier-syntax, or lookup guidance beyond what the schema provides, making 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 gives a specific verb and resource ('Get one OpenFGA instance of a cluster') and scopes it to a single item, which cleanly separates it from list/create/delete siblings by name pattern. It stops short of explicitly naming an alternative tool, so it does not reach the top of the scale.

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?

Usage is implied rather than stated: an agent can infer this is the call for fetching details of a known instance, and the phrase 'to call it with' hints at the connection-details use case. There is no explicit when-to-use vs. list_instances guidance and no prerequisites or exclusions mentioned.

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