Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Propose issuing a licence

license_issue_propose

Validates a licence issuance request and returns a proposal ID, hash, and confirm-token shape, without issuing anything until confirmed by license_issue.

Instructions

Create a proposal to issue a new licence. A proposal changes nothing by itself: it validates the request (product and tier must exist, seats must be >= 1 and default to the tier's, licensee needs a name and an email, and a term licence needs expires_at or a tier term) and returns a proposal id, its hash, and the confirm-token shape. Caller must be tenant_owner or issuer. Nothing is issued until license_issue executes the proposal with the bound confirm token under a live mandate. 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": {
      "product_id": "<product_id>",
      "tier_id": "<tier_id>",
      "_tenant_id": "<_tenant_id>",
      "_principal_id": "<_principal_id>"
    },
    "name": "license_issue_propose"
  }
}

Input Schema

NameRequiredDescriptionDefault
seatsNoSeat count (activation cap). Defaults to the tier's seats; must be >= 1.
sandboxNoTrue marks the licence as a sandbox/test issuance (default false).
tier_idYesDefined tier of that product (required).
featuresNoFeature list to grant. Defaults to the tier's features.
licenseeNoWho the licence is issued to; must carry name and email.
order_refNoExternal order reference carried into the artefact, for reconciliation with the seller's records.
perpetualNoTrue for a perpetual licence (no expiry). Defaults to the tier's setting.
_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_atNoISO-8601 expiry for a term licence. Omit for perpetual, or when the tier's term_days should set it.
product_idYesRegistered product to licence (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.
prev_license_idNoPrevious licence this issuance succeeds, when chaining manually; renewals normally go through license_renew_propose.

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.6/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: enumerates the validation rules applied, names the required caller roles (tenant_owner or issuer), discloses the return shape (proposal id, hash, confirm-token shape), and makes the non-idempotency concrete ('Each call creates a fresh proposal'). It also explains the security chain (confirm token bound under a live mandate) that an agent must satisfy before issuance succeeds.

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 the action and the non-effect, then the validation, auth, and follow-up call — a logical order with no filler sentences. The long parenthetical of validation rules is dense and would read better as a list, but every clause carries information an agent needs.

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 12-parameter non-idempotent creation tool this is close to complete: purpose, preconditions, role requirements, validation constraints, return artifacts, and the follow-up execution step are all covered. With an output schema present, it correctly avoids restating return fields.

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 goes further by stating the cross-parameter conditional that a term licence needs expires_at or a tier term, and by tying seats/licensee constraints to the validation step. It does not add format details or defaults beyond what the schema already documents.

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 ('Create a proposal to issue a new licence') and immediately separates it from the sibling that performs issuance ('Nothing is issued until license_issue executes the proposal'). An agent can distinguish this from license_issue and license_renew_propose 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear use context: call this when you want the request validated and a proposal/confirm token produced, and call license_issue afterwards to actually issue. The exclusions are implied through that two-step framing rather than stated as explicit 'do not use this for X', and the renewal alternative appears only in the schema, not the description.

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