Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

Inspect one licence with its receipts

license_inspect
Read-onlyIdempotent

Fetch a full stored licence record by ID, including terms, licensee, artefact hash, status history, and related journal receipts; unknown IDs return LICENSE_UNKNOWN. Read-only.

Instructions

Show one stored licence in full -- terms, licensee, artefact and artefact hash, status history fields -- together with every journal receipt that names it or its predecessor licence. Caller must be a principal of class tenant_owner, issuer, support_reader, or auditor; support_reader sees a masked licensee. An unknown id returns state LICENSE_UNKNOWN rather than an error. Use license_status for the cheap state-only check. Read-only.

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_inspect"
  }
}

Input Schema

NameRequiredDescriptionDefault
_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_idYesStored licence id to inspect.
_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
stateNo
licenseNo
receiptsNo
license_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered structurally. The description still adds real context beyond that: the permitted principal classes, the masking behavior for support_reader, and the fact that an unknown id yields state LICENSE_UNKNOWN rather than an error. It does not cover cost, latency, or the large-result implications of pulling every journal receipt, which is the main remaining behavioral gap.

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?

Front-loaded with the outcome the caller gets, followed by authorization, then error semantics, then the alternative tool. Every clause carries information, and the enumerated return fields are compressed rather than spelled out repetitively.

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 explained in prose. Given a 3-parameter read tool with full schema coverage and full annotation coverage, the description supplies everything an agent needs to decide and call correctly: authorization classes, masking behavior, and unknown-id semantics.

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 and the schema carries the parameter documentation. The description adds meaning on top of it by clarifying that the licence id resolution can reach a predecessor licence for receipt matching, and by stating the LICENSE_UNKNOWN outcome for an unresolvable id.

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 ('Show one stored licence in full') and enumerates the returned content (terms, licensee, artefact and artefact hash, status history fields, journal receipts including predecessor-licence receipts). That scope makes it clearly distinguishable from license_status, which the description explicitly routes cheap state checks to.

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?

Names an alternative, 'Use license_status for the cheap state-only check', and gives the condition that selects it, so an agent knows when to take the heavy path versus the light one. It also states the access classes required to call this tool, which is usage guidance an agent needs before choosing it.

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