Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Show one licence's current state

license_status
Read-onlyIdempotent

Retrieve the current computed state of a stored licence, such as valid, grace, expired, revoked, or superseded. Returns product, tier, expiry, perpetual flag, and seat count for a quick summary view.

Instructions

Show the current computed state of one stored licence: LICENSE_VALID, LICENSE_GRACE (inside the 14-day post-expiry grace), LICENSE_EXPIRED, LICENSE_REVOKED, LICENSE_SUPERSEDED, or LICENSE_UNKNOWN when the id is not the tenant's. Returns state plus product, tier, expiry, perpetual flag, and seat count -- the summary view. Use license_inspect for the full record with its journal receipts, and license_verify when an artefact string is in hand. Requires a valid _tenant_id. 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": {
      "license_id": "<license_id>",
      "_tenant_id": "<_tenant_id>"
    },
    "name": "license_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
_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_idYesStored licence id to report on.
_principal_idNoActing 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
seatsNo
stateNo
tier_idNo
perpetualNo
expires_atNo
license_idNo
product_idNo

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 declare readOnly, idempotent, non-destructive and closed-world, so "Read-only" is largely redundant. What the description adds beyond the annotations is real: the LICENSE_GRACE 14-day window semantics, the LICENSE_UNKNOWN outcome for a non-tenant id, and the shape of the returned summary. It does not mention output schema fields in depth, but the output schema covers that.

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?

Front-loaded with purpose, then states, then return fields, then alternatives, then precondition. Dense and mostly waste-free, though the recital of returned fields (product, tier, expiry, perpetual flag, seat count) duplicates the output schema and could be trimmed.

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?

Complete for a read-only lookup: it names the state space, the fallback state, the required scoping parameters, and both sibling alternatives. With an output schema present and full schema descriptions, no material gap remains.

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 behaviour the schema does not: an id that is not the tenant's yields LICENSE_UNKNOWN rather than an error, and the tenant requirement is restated as a calling condition. That is meaningful extra semantics for two required parameters.

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 ("Show the current computed state of one stored licence") and enumerates the exact state vocabulary, including LICENSE_UNKNOWN for an unknown id. An agent can distinguish this summary view from license_inspect and license_verify without opening any 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?

Explicitly routes to alternatives with the condition that selects them: license_inspect for the full record with journal receipts, license_verify when an artefact string is in hand. It also states the precondition of a valid _tenant_id, leaving nothing to inference.

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