Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Propose renewing a licence

license_renew_propose

Create a proposal to renew an existing license, validating the license and required expiry while inheriting omitted fields. Requires tenant_owner or issuer and changes nothing until confirmed.

Instructions

Create a proposal to renew an existing licence. Validates that the licence exists (unknown ids fail with LICENSE_UNKNOWN) and that a term licence gets a new expires_at; fields left out (tier, licensee, seats) inherit the current licence's values when license_renew executes. Caller must be tenant_owner or issuer. The proposal alone changes nothing and extends nothing. Each call creates a fresh proposal.

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

Input Schema

NameRequiredDescriptionDefault
seatsNoNew seat count; defaults to the current count.
tier_idNoTier to renew onto; defaults to the current tier.
licenseeNoReplacement licensee record; defaults to the current one.
_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.
expires_atNoNew ISO-8601 expiry. Required for term licences.
license_idYesLicence to renew (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
kindNo
payloadNo
proposal_idNo
proposal_hashNo
confirm_token_shapeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, destructiveHint=false, and idempotentHint=false; the description adds meaningful context by stating the no-op nature ('changes nothing and extends nothing') and non-idempotency ('Each call creates a fresh proposal'). It also discloses validation error behavior (LICENSE_UNKNOWN) and permission gating. It omits rate limits and the return payload, but the output schema covers the latter.

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?

Four dense sentences: purpose first, then preconditions, then the no-op semantics, then non-idempotency. No filler or redundancy.

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 7-parameter proposal tool with annotations and an output schema, the description covers authorization, validation, inheritance behavior, and no-op/non-idempotent traits. Nothing material is missing.

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%, and the schema already documents default behavior for seats, tier_id, licensee, and expires_at. The description's note that omitted tier, licensee, and seats inherit current values is useful but largely aligns with the schema. Baseline 3 is appropriate.

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?

Specific verb and resource: 'Create a proposal to renew an existing licence.' It distinguishes itself from the sibling license_renew by explicitly saying the proposal 'changes nothing and extends nothing' and that inheritance happens 'when license_renew executes.'

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?

The description states authorization requirements (tenant_owner or issuer), preconditions (licence must exist, term licences need expires_at), and the relationship to the alternative that actually executes renewal (license_renew). This gives explicit when-to-use and when-not context.

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