get_license_status Leave feedback

get_license_status reports how this server is licensed and, under metered licensing, how much has been consumed. Worth calling first: unlicensed search caps an index at 100 documents and a result at 10, and a capped answer looks complete. Example prompt: “Is the search 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.

None.

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

A JSON object describing the active licensing mode.

Evaluation mode — nothing configured:

{
  "mode": "evaluation",
  "licensed": false,
  "server": { "name": "GroupDocs.Search.Mcp", "version": "26.10.1" },
  "engine": { "name": "GroupDocs.Search", "version": "26.10" },
  "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.Search.Mcp", "version": "26.10.1" },
  "engine": { "name": "GroupDocs.Search", "version": "26.10" }
}

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

• “Is the search server licensed?”
• “Why do I only get 10 results?”
• “How much metered credit have I used?”