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.Signature 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-signature -- dnx GroupDocs.Signature.Mcp --yes
Folders, licensing and more →

get_license_status reports how this server is licensed and, under metered licensing, how much has been consumed. It takes no arguments and changes nothing. On this server it is worth calling before any signing run — see the two-page evaluation cap below. Example prompt: “Is the signature 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.Signature.Mcp", "version": "26.9.0" },
  "engine": { "name": "GroupDocs.Signature", "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.Signature.Mcp", "version": "26.9.0" },
  "engine": { "name": "GroupDocs.Signature", "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.Signature engine version
noteWhy licensing did not end up where you asked — present only when something needs attention

"mode": "evaluation" on this server means more than a watermark: only the first two pages are processed. See Licensing.

Example prompts

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