TM1 server tools

This tool set contains server tools for managing and interacting with TM1® processes and servers. Each tool includes input arguments, outputs, and example usage in natural language.

Overview

These tools are accessible through the /agentic-ai/analysis/mcp endpoint.

For REST-based authorization, this should follow the pattern https://{{PAW_HOST}}/api/{{PAW_TENANT_ID}}/v0/agentic-ai/analysis/mcp otherwise select the resource through applicable Workspace 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`	`data: string (JSON as string)`	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`	`data: string (JSON as string)`	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)`	`data: string`	Runs a TM1 process asynchronously on a specified server.
get_tm1_server_process_status	`server: string, process_name: string`	`data: string`	Retrieves the status of a specific TM1 process that is running on a specified server.
get_tm1_server_process_threads	`server: string`	`data: string`	Retrieves a list of active user threads that are associated with process executions on a given 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`	`data: 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`	`data: string`	Retrieves error logs for a TM1 process execution on a specified server.
Authoring
create_tm1_process	`server: string, process_name: string`	`data: 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.

Detailed Tool Documentation

The following sections provide detailed information about each tool.