Pulse MCP Tools

Pulse exposes a Model Context Protocol (MCP) endpoint so AI assistants can query and work with your Pulse and TM1 environment through a set of tools. This page lists the 35 documented Pulse MCP tools and what each one does.

How access works

The MCP endpoint is served at /mcp/* on the Pulse server.
Access is protected by an API key using bearer authentication. Every request must include an Authorization: Bearer <api-key> header.
The key is generated from your Pulse User Profile. See Create a Pulse API key.
For the connection methods supported by your MCP client, see Connect an MCP client to Pulse.

Every tool documented on this page is read-only. None of them create, update or delete Pulse configuration, and none of them modify a TM1 instance.

Pulse MCP tools

Instances and models

Tool	Type	What it does

Tool	Type	What it does
`get_instance_objects`	READ-ONLY	Returns the TM1 objects (applications, dimensions, cubes, rules, processes and chores) for a given TM1 instance.

TM1 metadata and source code

Tool	Type	What it does

Tool	Type	What it does
`get_cube_stats_history`	READ-ONLY	Returns cube statistics history (size, memory and similar) for a TM1 cube.
`get_dimension_elements`	READ-ONLY	Returns the elements and attributes of a TM1 dimension.
`get_rule_statistics`	READ-ONLY	Returns rule statistics history for a TM1 cube, optionally filtered by line number.
`search_source_code`	READ-ONLY	Full-text search across the TM1 service's source files. Query format is `terms::extensions`.

Monitoring and history

Tool	Type	What it does

Tool	Type	What it does
`get_server_state`	READ-ONLY	Returns the latest state across all Pulse environments: service status, recent message logs and alerts.
`get_process_history`	READ-ONLY	Returns TM1 process and chore execution history statistics for a service over a date range, optionally filtered by type.
`search_process_history`	READ-ONLY	Searches TM1 process and chore execution history with date, time and name filters.
`list_changes`	READ-ONLY	Returns the source-control change history for a Pulse environment, optionally filtered by service, date range or type.

Migration

Tool	Type	What it does

Tool	Type	What it does
`list_migration_packages`	READ-ONLY	Returns Pulse migration packages, optionally with execution history filtered by date range.
`get_migration_package`	READ-ONLY	Returns the full details of a migration package, including execution and approval history.
`list_migration_approvals`	READ-ONLY	Returns migration package approval requests. Each request carries a status code (0 pending, 1 approved, 2 rejected) and a dismissed flag. A dismissed request no longer authorises execution regardless of its status, so status 1 with dismissed true means the approval was revoked.

Requests and service control history

Tool	Type	What it does

Tool	Type	What it does
`list_cancel_requests`	READ-ONLY	Returns the TM1 thread cancel requests for a Pulse environment within a date range.
`list_disconnect_requests`	READ-ONLY	Returns the TM1 session disconnect requests for a Pulse environment within a date range.
`list_service_requests`	READ-ONLY	Returns the TM1 service control requests (start, stop and similar) for a Pulse environment within a date range.

Canvas usage

Tool	Type	What it does

Tool	Type	What it does
`list_canvas_logs`	READ-ONLY	Returns Canvas page usage (open count and last opened) aggregated across all pages in a date range.
`list_canvas_open_pages`	READ-ONLY	Returns Canvas pages currently open, within the configured TM1 Web open-timeout window.
`get_canvas_page`	READ-ONLY	Returns usage detail for a single Canvas page: recent open log and opens-by-day series.

Excel workbook usage

Tool	Type	What it does

Tool	Type	What it does
`list_workbooks`	READ-ONLY	Returns Excel workbooks with usage aggregates (open count, last opened, sheets, file size) over a date range.
`list_workbooks_open`	READ-ONLY	Returns Excel workbooks currently open, within the configured workbook open-timeout window.
`get_workbook`	READ-ONLY	Returns detailed Excel workbook usage: opens and saves by day, worksheets, and the recent usage log.

TM1 Web websheet usage

Tool	Type	What it does

Tool	Type	What it does
`list_websheets`	READ-ONLY	Returns aggregated TM1 Web websheet usage (open count and last opened) over a date range.
`list_websheets_open`	READ-ONLY	Returns TM1 Web websheets currently open, within the configured TM1 Web open-timeout window.
`get_websheet`	READ-ONLY	Returns usage for one TM1 Web websheet: recent open log and opens-by-day series.

Sessions and user activity

Tool	Type	What it does

Tool	Type	What it does
`get_user_sessions`	READ-ONLY	Returns a per-user session summary and named-user time series for a Pulse environment, optionally filtered by service.
`get_system_sessions`	READ-ONLY	Returns the Pulse system session summary, log summary, raw sessions and raw audit logs over a date range.
`get_system_session_user`	READ-ONLY	Returns Pulse system sessions and logs for a specific Pulse user over a date range.
`get_user_activity`	READ-ONLY	Returns activity for a Pulse user: services, sessions, operations and, optionally, workbooks and websheets over a date range.

Performance and licensing

Tool	Type	What it does

Tool	Type	What it does
`get_performance_server`	READ-ONLY	Returns server-level performance metrics for a Pulse environment: average and maximum memory and CPU by day, top consumption windows, and alerts.
`get_performance_instance`	READ-ONLY	Returns instance-level performance metrics for a TM1 instance: uptime, memory, CPU and threads by day, restarts, alerts and top operations.
`get_license_report`	READ-ONLY	Returns the license-optimisation report: concurrent users by date, named users by date, and a per-user session summary.

Settings and configuration

Tool	Type	What it does

Tool	Type	What it does
`list_system_alerts`	READ-ONLY	Returns Pulse system alerts for a TM1 environment, optionally with email groups and available alert types.
`list_validations`	READ-ONLY	Returns the Pulse validation rules configured for the server.
`get_system_summary_report`	READ-ONLY	Returns the scheduled System Summary Report configuration for a service, or the available email groups if no service is given.

Built-in

Tool	Type	What it does

Tool	Type	What it does
`get_version`	READ-ONLY	Returns the Pulse version. Useful as a first call to confirm the MCP connection works.