get_license_status

get_license_status reports how this server is licensed and, under metered licensing, how much has been consumed. It takes no arguments, processes no document, and changes nothing — so it is the cheapest way to confirm a licensing setup actually took effect. Example prompt: “Is the conversion server licensed, and how much metered credit is left?”

Note
Added in server version 26.9.0 (GroupDocs.Mcp.Core 26.9.0). Earlier servers do not expose this tool.

Tool description (as the AI agent sees it):

Returns how this MCP server is licensed, and — under metered licensing — how much has been consumed. Call this when the user asks about licensing, evaluation limitations, metered usage, remaining credit, or which product engine version is running. Returns a JSON object with mode (“evaluation”, “licensed” or “metered”), licensed (true for both licensed and metered), consumption (null unless metered; otherwise quantity and credit, or error if the reading failed), and server / engine name and version. Takes no arguments and never modifies anything.

Parameters

None.

Example call

{
  "name": "get_license_status",
  "arguments": {}
}

Result

A JSON object describing the active licensing mode.

Evaluation mode — nothing configured:

{
  "mode": "evaluation",
  "licensed": false,
  "server": { "name": "GroupDocs.Conversion.Mcp", "version": "26.9.0" },
  "engine": { "name": "GroupDocs.Conversion", "version": "26.6.0.0" },
  "note": "No license configured — output may carry evaluation limitations. ..."
}

The full note text names the variables to set: GROUPDOCS_METERED_PUBLIC_KEY and GROUPDOCS_METERED_PRIVATE_KEY for metered licensing, or GROUPDOCS_LICENSE_PATH for a license file.

Metered mode — both keys accepted:

{
  "mode": "metered",
  "licensed": true,
  "source": "metered-keys",
  "consumption": { "quantity": 1234.5678, "credit": 9642.0 },
  "server": { "name": "GroupDocs.Conversion.Mcp", "version": "26.9.0" },
  "engine": { "name": "GroupDocs.Conversion", "version": "26.6.0.0" }
}
FieldMeaning
modeevaluation, licensed, or metered
licensedtrue for both licensed and metered
sourcemetered-keys or license-file; absent in evaluation mode
consumption.quantityAmount consumed — account-wide, null outside metered mode
consumption.creditCredits consumed so far
server / engineMCP server version and the underlying GroupDocs.Conversion engine version
noteWhy licensing did not end up where you asked — present only when something needs attention

A key pair that the engine rejects does not fail silently: the mode reverts to evaluation and note carries the reason, so you learn it here rather than from a watermark on your output. See Licensing.

Example prompts

  • “Is the conversion server licensed?”
  • “How much metered credit have I used?”
  • “Which GroupDocs.Conversion engine version is this server running?”