Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

List activations

activation_list
Read-onlyIdempotent

Lists every activation for a tenant and filters results by licence or status (live, deactivated, reclaimed), so you can audit seat assignments and track activation state.

Instructions

List every activation recorded for the caller's tenant, optionally filtered by license_id or by status (live, deactivated, reclaimed). Caller must be a principal of class tenant_owner, issuer, or support_reader; support_reader sees truncated install ids. Returns the activations, a count, and the surface served. Use seat_usage for the per-licence cap-versus-live summary. 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": "activation_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusNoOptional filter: only activations with this status.
_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.
license_idNoOptional filter: only activations of this licence.
_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
activationsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent and non-destructive behavior, and the description adds materially: required principal classes (tenant_owner, issuer, support_reader), the truncation of install ids for support_reader, and the shape of the result (activations, count, surface served). It does not mention pagination or result-size limits for what is described as an exhaustive list, which is a notable omission for a 'list every' tool.

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 dense sentences that lead with the core action and filters before privileges and return shape; nothing is padded. The trailing 'Read-only.' duplicates readOnlyHint and is the only wasted token.

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?

An output schema exists, so return values need not be spelled out, yet the description still sketches them. Combined with the principal-class gating and the sibling pointer, an agent has everything needed to select and invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds value the schema lacks: it enumerates the status values (live, deactivated, reclaimed) even though the schema declares no enum, and clarifies that both filters are optional. The tenant/principal semantics are left to 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?

States a specific verb and resource ('List every activation recorded for the caller's tenant') plus the two optional filters (license_id, status) and the allowed status values. It is immediately distinguishable from seat_usage, which it names explicitly.

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?

Gives an explicit routing rule: use seat_usage for the per-licence cap-versus-live summary instead of this tool. It also states the caller-class prerequisite and what support_reader sees, so an agent knows both when to call it and whether it will succeed.

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