TM1 server tools

Manage TM1® processes and servers with natural-language or structured queries.

Overview

This tool set provides Model Context Protocol (MCP) server tools to manage and interact with TM1 processes and servers. Each tool defines input arguments, outputs, and usage patterns for natural-language and structured queries.

Some tools retrieve replica-level metrics, such as CPU, memory, and storage usage.

Access these tools through the /agentic-ai/ibm-pa-tools/mcp endpoint.

For REST-based authorization, follow the pattern https://<PAW_HOST>/api/<PAW_TENANT_ID>/v0/agentic-ai/ibm-pa-tools/mcp or select the resource through the applicable Planning Analytics Workspace REST API base path.

Quick Reference – All Tools

Tool Input Arguments Output Notes
Discovery and inspection
get_available_tm1_servers None results: list[str] Retrieves a list of available TM1 servers.
get_tm1_processes server: string result: object Retrieves a list of TM1 processes on a specified server, including process parameters, data types, and default values.
get_tm1_process_details server: string, process_name: string result: object Retrieves detailed metadata for a specific TM1 process, including script logic, parameters, and default values.
Execution and monitoring
execute_tm1_processes_asynchronously server: string, process_name: string, parameters: list[object] (optional) result: string Runs a TM1 process asynchronously on a specified server.
get_tm1_server_process_status server: string, process_name: string result: string Retrieves the status of a specific TM1 process that is running on a specified server.
get_tm1_server_process_threads server: string result: string Retrieves a list of active user threads that are associated with process executions on the specified TM1 server. Filters threads where the type is User and the function indicates an active process.
cancel_tm1_process_execution server: string, process_name: string result: string Cancels the execution of a running TM1 process on a specified server.
get_tm1_server_process_execution_error_logs server: string, process_name: string result: string Retrieves error logs for a TM1 process execution on a specified server.
Authoring
create_tm1_process server: string, process_name: string result: string Creates a new empty TM1 process on a specified server.
update_tm1_process server: string, process_name: string, code sections and parameters (optional) success: boolean, message: string Updates the definition of an existing TM1 process by modifying its code sections and parameters.
delete_tm1_process server: string, process_name: string success: boolean, message: string Permanently deletes a TM1 process from a specified server.
Metrics
get_tm1_replica_metrics server: string results: list[object] Retrieve replica-level metrics such as CPU, memory, and storage usage. Metrics are returned as named entries from the TM1 Metrics API rather than as fixed output fields.

Detailed Tool Documentation

The following sections provide detailed information about each tool.