Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Propose revoking a licence

license_revoke_propose

Create a proposal to revoke an existing licence with a journalled reason. Revocation applies only when the proposal is executed, giving tenant owners and issuers a review step before clients see it at check-in.

Instructions

Create a proposal to revoke an existing licence, with a reason that will be journalled at execution. Validates that the licence exists (unknown ids fail with LICENSE_UNKNOWN). Caller must be tenant_owner or issuer. The proposal alone revokes nothing: revocation happens only when license_revoke executes it, and connected clients then see the revocation at their next check-in. 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_revoke_propose"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonNoReason recorded in the journal at revocation (for example a refund or chargeback reference).
_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_idYesLicence to revoke (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?

Beyond the annotations, it discloses authorisation requirements, upstream validation with a named error code, that each call produces a fresh (non-idempotent) proposal, and the downstream effect that connected clients see the revocation at their next check-in. The remaining gap is modest: it doesn't describe the proposal's own lifecycle (expiry, supersession) or what the returned proposal looks like.

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?

Five short sentences, each carrying distinct information: what it does, validation, authorisation, the non-effect of the proposal plus where the real effect comes from, and the fresh-proposal-per-call caveat. Front-loaded and free of 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 shape needn't be explained, and the description covers the remaining essentials for a mutation-adjacent proposal tool: permissions, validation failure, idempotency, and the actual revocation path. Nothing 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.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters are already documented, including the reason, tenant, and principal semantics. The description reinforces that the reason is journalled at execution, but adds no syntax or format detail beyond the schema, so the baseline 3 applies.

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 description opens with a specific verb+resource pair ("Create a proposal to revoke an existing licence") and immediately distinguishes the two-step design from the sibling license_revoke, which performs the actual revocation. An agent can tell this apart from license_issue_propose/license_renew_propose by the resource named.

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?

It explicitly states when to use this versus the alternative: "The proposal alone revokes nothing: revocation happens only when license_revoke executes it." It also names the preconditions (caller must be tenant_owner or issuer) and the failure mode (unknown ids fail with LICENSE_UNKNOWN), leaving no inference required.

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