Skip to main content
Glama
Cyan Eclipse License Server

Cyan Eclipse License Server

Official

List journal receipts

journal_list
Read-onlyIdempotent

Lists a tenant's hash-chained license journal receipts in sequence order with limit/offset paging for auditing issue, renew, revoke, activation, and refusal events.

Instructions

List the caller's tenant journal receipts in sequence order, paged by limit (default 100) and offset. Each receipt is one hash-chained lifecycle entry (issue, renew, revoke, activation events, refusals of note). Caller must be a principal of class tenant_owner, issuer, support_reader, or auditor. Use receipt_get for a single known sequence and chain_verify when integrity, not content, is the question. 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": {
      "_tenant_id": "<_tenant_id>",
      "_principal_id": "<_principal_id>"
    },
    "name": "journal_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum receipts to return (default 100).
offsetNoReceipts to skip before the page starts (default 0).
_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.
_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
receiptsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, and the description still adds real context: caller-scoped tenant listing, a default page size of 100 with offset paging, and an authorization gate by principal class. The closing 'Read-only' repeats the annotation, but that is the only redundancy.

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?

Three sentences, each doing distinct work: scope and paging first, then what a receipt is, then the authorization gate, then sibling routing. No filler and the most decision-relevant information is front-loaded.

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 need not be explained, and the description instead covers ordering, paging defaults, receipt semantics and access class. Nothing an agent needs in order to call this 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 coverage is 100% and the schema already documents limit (default 100), offset (default 0), _tenant_id and _principal_id in detail. The description only restates the paging defaults and the tenant scoping already present in the schema, adding no new syntax or constraint such as a maximum page size. 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?

States a specific verb and resource (list journal receipts), the ordering (sequence order), and the paging scheme. The sentence about hash-chained lifecycle entries (issue, renew, revoke, activation, refusals) clarifies what a receipt actually is, which separates this from receipt_get and chain_verify without needing their schemas.

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?

Explicitly names two sibling alternatives and the condition that selects each: receipt_get for a single known sequence, chain_verify when integrity rather than content is the question. It also states the prerequisite for calling at all (principal class tenant_owner, issuer, support_reader, or auditor), so an agent can rule itself in or out before invoking.

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