Tools and capabilities reference
The OpenLM MCP Connector exposes 19 tools covering 12 data categories. Each data category is a single tool that accepts an operation parameter, and each operation maps to a specific GraphQL query against your OpenLM database. Your AI assistant calls these tools automatically based on your natural language prompts.
You do not need to call tools by name or set the operation yourself. Describe what you need in plain language and the AI client selects the appropriate tool and operation.
How to read this reference
Each category entry includes:
- Tool. The machine-readable tool identifier used by the MCP protocol.
- Operations. The actions the tool supports through its
operationparameter. - Safety. Whether the tool is safe and does not change your reporting data (
read_only) or changes server or session state (destructive). These labels describe behavior. - Example prompts. Natural language queries that trigger the tool.
The operation model
Each data-category tool supports the same set of operations. Understanding these tells you what kinds of questions you can ask for any category:
| Operation | What it does |
|---|---|
list | Retrieves paginated, filterable records. Use for browsing data or applying specific filters. |
by_id | Fetches a single record by its unique identifier. Use when you need details about a specific item. |
summary | Returns high-level totals, averages, and unique counts. Use for overviews and KPIs. |
aggregates | Groups data by a column (such as feature, user, or host) and returns metrics per group. Use for comparisons. |
group_summary | Breaks down summary metrics per group. Use for department-level or team-level analysis. |
overview | Returns the summary and the per-group breakdown together in a single request. Use for dashboards. |
The AI selects the operation automatically from your wording; you simply ask in plain language.
The aggregates operation supports COUNT, SUM, AVG, MIN, MAX, and COUNT_DISTINCT, depending on the category and the field being aggregated.
Account and session management (3 tools)
Tools for verifying your identity and session context. These are typically called automatically by the AI client at the start of a session.
| Tool name | Description | Safety |
|---|---|---|
get_openlm_identity | Returns the authenticated user identity for the current MCP session, including tenant and account details. | read_only |
link_openlm_account | Starts the OpenLM Identity login for the session. | read_only |
unlink_openlm_account | Logs out of the current OpenLM Identity session. | destructive |
Example prompts
- "Who am I logged in as?"
- "Show my OpenLM identity."
- "Log me out of OpenLM Identity."
Cache management (2 tools)
| Tool name | Description | Safety |
|---|---|---|
cache_stats | Returns current cache statistics, including size, maximum size, and TTL. | read_only |
clear_cache | Clears the server-side cache so the next queries fetch fresh data. | destructive |
Example prompts
- "Show me the current cache statistics."
- "Clear the cache so I get fresh data."
License usage
The core reporting tool. Query license consumption data across your organization with support for pagination, filtering, aggregation, and group-level breakdowns.
| Tool name | Operations | Safety |
|---|---|---|
license_usage | list, by_id (by usage ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me all license usage for the past 30 days."
- "Give me a summary of our license usage this quarter."
- "Break down license usage by department."
License allocation
Query license allocation and assignment data to understand how licenses are distributed across your organization.
| Tool name | Operations | Safety |
|---|---|---|
license_allocation | list, by_id (by allocation ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me all current license allocations."
- "What percentage of our license allocations are active?"
- "Show me the allocation status for each department."
License procurement
Track license procurement records, including purchase dates, expiration status, and renewal timelines.
| Tool name | Operations | Safety |
|---|---|---|
license_procurement | list, by_id (by feature + vendor + server), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me all our license procurement records."
- "How many of our licenses are expiring in the next 90 days?"
- "Show me which departments have licenses expiring soon."
License server status
Monitor the health and status of your license servers.
| Tool name | Operations | Safety |
|---|---|---|
server_status | list, by_id (by transaction ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me the status of all our license servers."
- "Give me a summary of all license server health."
- "Aggregate server status by host."
Concurrent measures
Analyze concurrent license usage patterns, including peak concurrent sessions, minimum/maximum values, and utilization percentages.
| Tool name | Operations | Safety |
|---|---|---|
license_concurrent_measure | list, by_id (by license ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me concurrent license usage for the past week."
- "What is our average peak concurrent usage this month?"
- "Break down concurrent usage by product."
Denials
Track and analyze license denial events when users cannot check out a license.
| Tool name | Operations | Safety |
|---|---|---|
denial | list, by_id (by transaction ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me all license denials from the past month."
- "How many license denials have we had this quarter?"
- "Which features have the most license denials?"
Not-used licenses
Identify licenses that are allocated but not being used. These are essential for license optimization and cost reduction.
| Tool name | Operations | Safety |
|---|---|---|
not_used_license | list, by_id (by license ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Which licenses have not been used?"
- "Give me a summary of all unused licenses."
- "Which departments have the most unused licenses?"
Processes
Query process-level data to see which applications and sessions consume licenses.
| Tool name | Operations | Safety |
|---|---|---|
process | list, by_id (by transaction ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me all active license processes."
- "Give me a summary of license process activity."
- "Aggregate process data by application name."
Touchpoint details
Track touchpoint events across your license infrastructure.
| Tool name | Operations | Safety |
|---|---|---|
touchpoint | list, by_id (by row number), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me all touchpoint events from the past week."
- "How many touchpoint events occurred this month?"
- "Break down touchpoint events by group."
Dongle monitoring
Monitor hardware dongle status, connectivity, and usage for dongle-based license enforcement.
| Tool name | Operations | Safety |
|---|---|---|
dongle | list, by_id (by row number), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me the status of all monitored dongles."
- "Give me a summary of dongle health and connectivity."
- "Aggregate dongle data by connection status."
User details
Query the user directory, including departments, offices, countries, and groups.
| Tool name | Operations | Safety |
|---|---|---|
user_detail | list, by_id (by user name), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "List all users."
- "How many users are in each department?"
- "Break down users by country."
License details
Query the license inventory, including features, vendors, products, and quantities.
| Tool name | Operations | Safety |
|---|---|---|
license_detail | list, by_id (by license ID), summary, aggregates, group_summary, overview | read_only |
Example prompts
- "Show me our license inventory."
- "Give me a summary of licenses by vendor."
- "Break down licenses by license type."
Seat availability (2 tools)
Purpose-built tools that answer seat-availability questions directly.
| Tool name | Description | Safety |
|---|---|---|
license_seat_availability | Floating-license seat availability (total seats, in use, available, utilization percentage) for a feature or product on a date — or a concurrent-usage trend over a date range. | read_only |
named_user_seat_availability | Named-user (per-seat) allocation lookup — who holds a seat for a feature and whether they are currently using it. | read_only |
Example prompts
- "How many seats of REVIT are available today?"
- "Show the concurrent usage trend for AutoCAD over the last 30 days."
- "Who currently holds a named-user seat for MATLAB?"
Tips for effective prompting
- Be specific about time ranges. Include date ranges, months, or quarters for more relevant results.
- Name specific products or features. Mention the software product, license, or feature name when querying feature-level data.
- Ask for an overview. For a dashboard-style answer, ask for an "overview of X by Y" — it returns totals plus the per-group breakdown in one step.
- Ask follow-up questions. Start broad with a summary, then drill down into specifics.
- Request specific output formats. Ask for tables, charts, or dashboards if you want visual output.
- Combine categories. Ask questions that span multiple tool categories, such as "Compare license usage to denial rates by department."
- Use the cache. For repeated queries, results are cached. If you need fresh data after a known update, ask the AI to clear the cache first.
Verify AI-generated insights, especially license optimization recommendations, against your OpenLM Platform BI reports and dashboards before making business decisions. AI models can have up to 3% inaccuracy in data interpretation.