Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

List the tenant's licences

license_list
Read-onlyIdempotent

List all licences stored for a tenant, optionally filtered by product or computed state, to audit licence status in bulk. Read-only and role-gated; licensee data is masked for support readers.

Instructions

List every licence stored for the caller's tenant, optionally filtered by product_id or by computed state (for example LICENSE_REVOKED). Caller must be a principal of class tenant_owner, issuer, support_reader, or auditor. On the support surface (support_reader) licensee details are masked; other classes see the full record. Use license_inspect for one licence with its receipts; this tool returns the same per-licence view in bulk plus a count and the surface served. Read-only.

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": {
      "_tenant_id": "<_tenant_id>",
      "_principal_id": "<_principal_id>"
    },
    "name": "license_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
stateNoOptional filter: only licences whose computed state equals this value (e.g. LICENSE_VALID).
_tenant_idYesTenant the call acts for. The tenant must exist; an unknown tenant is refused with state LICENSE_UNKNOWN. Transport authentication is a deployment concern -- this parameter scopes the call, it does not authenticate it.
product_idNoOptional filter: only licences for this product.
_principal_idYesActing principal inside the tenant. Principal-gated tools refuse unknown principals and principals of the wrong class; executions (tier T2) additionally require a live, unexpired mandate covering the product and the operation class.

Output Schema

NameRequiredDescriptionDefault
countNo
surfaceNo
licensesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, it discloses the authorization gate by principal class, the masking behavior on the support surface for support_reader, and the extra return elements (count and surface served). It also notes the unknown-tenant refusal via the schema, giving concrete behavioral context.

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?

Three sentences plus a trailing 'Read-only' are front-loaded with scope, then exclusions, then the sibling alternative. The closing 'Read-only' restates what readOnlyHint already declares and could be dropped.

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?

With an output schema present, return values need not be explained, yet the description still flags the count and surface served. Authorization classes, filtering, and the sibling boundary are all covered for a four-parameter list tool.

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 coverage is 100%, so both required and optional parameters are already documented. The description adds only a light gloss on the two optional filters and one example state value (LICENSE_REVOKED), which is marginal over the schema's own descriptions.

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?

The description states a specific verb and resource ('List every licence stored for the caller's tenant') plus its scoping and optional filters, and explicitly distinguishes itself from license_inspect by noting this returns the same per-licence view in bulk. An agent can identify the tool's role without opening the schema.

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

Usage Guidelines5/5

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

It names the alternative (license_inspect) and the condition that selects it (one licence with its receipts), and specifies the exact principal classes permitted to call. Nothing about when to pick this versus a sibling 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.