Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Register a product

product_register

Register a new product in the caller's tenant so tiers can be defined and licences issued; do this before tier_define and use a product_id unique to the tenant.

Instructions

Register a product in the caller's tenant so tiers can be defined and licences issued for it. Tenant_owner only. The registration is journalled. product_id must be new to the tenant (re-registering an existing id fails). custody records the key-custody model for the product: 'witness' (the default -- the tenant holds its signing keys and the platform stores public keys only) or a custodial election where the deployment supports it. Do this before tier_define for the product.

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

Input Schema

NameRequiredDescriptionDefault
nameNoDisplay name; defaults to the product_id.
custodyNoKey-custody model: 'witness' (default) or 'custodial'.
_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_idYesNew product id, unique within the tenant (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
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 only declare it is a non-read-only, non-idempotent, non-destructive write; the description goes further by disclosing the tenant_owner authorisation requirement, that the registration is journalled, and that re-registering an existing id fails (consistent with idempotentHint=false). It also explains the key-custody consequences of the custody choice, which no annotation covers. It stops short of describing the registration record returned, though an output schema exists to carry 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?

Dense and purposeful with no filler sentences; purpose leads, and each clause contributes a constraint, failure mode, or preconditions. The ordering note sits at the end rather than up front, which is a minor structural miss but the paragraph is short enough that nothing is buried.

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?

For a 5-parameter mutation tool with an output schema and annotations, the description covers authorisation, audit journaling, identifier uniqueness, custody semantics, and call ordering. With the return value handled by the output schema, no information an agent needs to invoke it correctly 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, but the description adds real meaning: product_id carries a uniqueness invariant against existing tenant products, and custody is framed as a security-model election ('witness' = tenant holds signing keys, platform stores public keys only) that is only available 'where the deployment supports it'. That deployment-support caveat is not in the schema.

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 ('Register a product in the caller's tenant') plus the downstream consequence ('so tiers can be defined and licences issued for it'). It explicitly distinguishes sequencing against the sibling tier_define, so an agent knows exactly where this sits relative to alternatives.

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 the caller restriction ('Tenant_owner only'), the ordering rule ('Do this before tier_define for the product'), and the precondition ('product_id must be new to the tenant (re-registering an existing id fails)'). When-to-use, when-it-fails, and the prerequisite relationship are all stated rather than inferred.

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