Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Define a product tier (new version)

tier_define

Define a versioned tier for a registered product, creating the next version with its own journal receipt for auditable licence terms.

Instructions

Define a tier for a registered product. Tiers are versioned and never edited in place: every call creates the next version (previous max + 1) with its own journal receipt, and returns that version. Tenant_owner only; the product must already be registered (see product_register). Defaults: features [], seats 1, perpetual false, term_days null (a term licence then needs an explicit expires_at at proposal time).

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

Input Schema

NameRequiredDescriptionDefault
seatsNoDefault seat count for licences on this tier (default 1).
tier_idYesTier id within the product (required).
featuresNoFeature list the tier grants (default []).
perpetualNoTrue if the tier is perpetual by default.
term_daysNoDefault term length in days for term licences on this tier.
_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_idYesRegistered product (required).
_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
receiptNo
tier_idNo
versionNo
product_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations declare idempotentHint=false and destructiveHint=false; the description explains why by stating every call creates the next version (previous max + 1) and never edits in place, so retries are not safe. It also discloses the journal receipt side effect, the returned version, the tenant_owner gate, and the term_days null consequence at proposal time — all context the annotations cannot carry.

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?

Three sentences, front-loaded with the versioning rule that most affects agent behavior, then authorization, then defaults. Every clause carries information an agent needs before calling; there is no filler.

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 detailed beyond the note that the new version is returned. For an 8-parameter mutation with auth gating, the description covers prerequisites, authorization class, non-idempotent semantics, side effects, and defaults — nothing material is missing.

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; the description adds the cross-parameter consequence that a null term_days forces an explicit expires_at at proposal time, which the schema does not say. The other defaults it lists (features [], seats 1, perpetual false) largely restate schema descriptions, keeping it short of a 5.

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 first sentence names a specific verb and resource ('Define a tier for a registered product') and the rest scopes it to versioned creation rather than in-place editing. The reference to product_register makes clear this is not the product-creation tool, so an agent can separate it from the sibling without opening a schema.

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?

It states a hard prerequisite ('the product must already be registered (see product_register)') and an authorization condition ('Tenant_owner only'), which tells the agent when the call will be refused. It stops short of naming an alternative for editing or superseding an existing tier, so it is clear context rather than full when/when-not routing.

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