get_license_status

View as MarkdownMarkdown

Set up your AI agent

Give your coding agent live access to the GroupDocs documentation and API reference through the GroupDocs Docs MCP server — no install, no API key. Learn more

claude mcp add --transport http groupdocs-docs https://docs.groupdocs.com/mcp

Also process documents locally

The GroupDocs.Viewer MCP server lets your agent work with files on your machine; they are never uploaded. It needs the .NET 10 SDK or Docker.

claude mcp add groupdocs-viewer -- dnx GroupDocs.Viewer.Mcp --yes
Folders, licensing and more →

get_license_status reports how this server is licensed and, under metered licensing, how much has been consumed. Call it before rendering pages you will share — evaluation mode watermarks every image. Example prompt: “Is the viewer server licensed?”

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.Viewer.Mcp", "version": "26.9.0" },
  "engine": { "name": "GroupDocs.Viewer", "version": "26.4" },
  "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.Viewer.Mcp", "version": "26.9.0" },
  "engine": { "name": "GroupDocs.Viewer", "version": "26.4" }
}
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.Viewer engine version
noteWhy licensing did not end up where you asked — present only when something needs attention

"mode": "evaluation" watermarks your images: every rendered page carries an evaluation watermark, and one server process opens at most 15 documents.

A rejected key pair does not fail silently: the mode reverts to evaluation and note carries the reason. See Licensing.

Example prompts

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