Tool reference

Tool Parameters

These tools are available through REST endpoints and MCP tool calls. REST calls use the same tool names as endpoint paths. MCP calls pass the same JSON argument objects.

create_simulation

Create a new simulation and return a sim_id.

Parameter	Required	Type	Description
`scenario_model`	Yes	enum	`ITU_R_M2135_UMa`, `ITU_R_M2135_UMi`, `ITU_R_M2135_UMa_multilayer`, or `3GPPTR38_901_4G_5G_multilayer`.
`ue_distribution`	Yes	enum	`uniform`, `uniform_with_hotspots`, `inhomogeneous_per_cell`, or `grid`.
`link_direction`	Yes	enum	`downlink`, `uplink`, or `downlink_uplink`.
`number_of_episodes`	No	integer	Independent simulation episodes. Default `1`.
`number_of_steps`	No	integer	Decision intervals per episode. Default `1`.

load_scenario

Load a pre-configured scenario and return a ready-to-run sim_id.

Parameter	Required	Type	Description
`scenario_id`	Yes	string	Scenario identifier available on the server, such as `q21`.

list_simulations

List retained simulations in the current workspace. Takes no parameters.

clone_simulation

Clone an existing simulation into a new editable run.

Parameter	Required	Type	Description
`source_sim_id`	No	string	Simulation to clone. Omit to clone the latest simulation.
`number_of_episodes`	No	integer	Episode count for the clone. Omit to inherit from source.

delete_simulation

Delete a simulation and release its state.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation to delete. Omit to delete the latest simulation.

get_engineering_parameters

Read cell/site engineering configuration values. Cell roles, pairings, and carrier-shutdown settings are available through get_carrier_management_config.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`parameters`	No	string[]	Engineering parameter names to return. Omit for all.
`cells`	No	string[]	Cell names such as `cell_0`. Omit for all.

See Parameter Catalog for names and writeability.

set_engineering_parameter

Set one writable engineering parameter before running.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`parameter`	Yes	string	Writable engineering parameter name.
`value`	Yes	number/string/bool	Absolute value for `set` mode or increment for `delta` mode.
`cells`	No	string[]	`["all"]` by default, or a list of cell names.
`mode`	No	enum	`set` or `delta`. Default `set`.

get_carrier_management_config

Read cell roles, pairings, and carrier-shutdown settings before or after a run. REST: POST /api/get_carrier_management_config.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`cells`	No	string[]	Cell names such as `cell_0`. Omit for all cells.

Returns sim_id and a data array. Each row includes ID, name, site_ID, site_name, and the fields in Carrier Management Parameters.

set_carrier_management_config

Apply partial carrier-management updates to one or more cells in a single request. REST: POST /api/set_carrier_management_config. Call before run_simulation; clone a completed simulation to edit its configuration.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`updates`	Yes	object[]	Nonempty list of cell updates; each cell may appear once.
`updates[].cell`	Yes	string	Cell name, such as `cell_0`.
`updates[].cell_role`	No	enum	`coverage` or `capacity`.
`updates[].paired_cell`	No	integer[]	Paired cell IDs (the `ID` values from the read endpoint); `[]` clears the pairing.
`updates[].radio_enable_carrier_shutdown`	No	boolean	JSON `true` or `false`.
`updates[].carrier_shutdown_currentCell_usage_threshold`	No	number	Finite PRB usage threshold below which a capacity cell shuts down.
`updates[].carrier_wakeUp_pairedCell__currentCell_usage_threshold`	No	number	Finite PRB usage threshold above which a coverage cell wakes its paired capacity cell.

Each update must contain at least one field besides cell. Fields not supplied remain unchanged. The API does not automatically create reciprocal pairings or enforce coverage-capacity pairing; configure both sides deliberately. The response contains sim_id and updated_cells.

{
  "sim_id": "ITU_R_M2135_UMa_multilayer_uniform_abc123",
  "updates": [
    {"cell": "cell_34", "paired_cell": [91]},
    {"cell": "cell_91", "paired_cell": [34],
     "radio_enable_carrier_shutdown": true,
     "carrier_shutdown_currentCell_usage_threshold": 0.35}
  ]
}

run_simulation

Execute a configured simulation. Parameters are frozen after the run.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation to run. Omit to run the latest simulation.

get_aggregated_results

Return KPI statistics for a completed simulation, grouped by the selected entities or episodes.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`kpis`	No	string[]	KPI names. Omit for all available KPIs.
`group_by`	No	enum	`all`, `cells`, `ues`, `episodes`, `radios`. Default `all`.
`metrics`	No	string[]	`mean`, `median`, `min`, `max`, `std`, `p5`, `p10`, `p25`, `p75`, `p90`, `p95`, `p99`.
`episodes`, `cells`, `ues`, `radios`	No	arrays	Optional filters applied before aggregation.
`round_digits`	No	integer	Optional rounding from 0 to 12 decimal places.

get_results

Return KPI values for a completed simulation, indexed by episode and entity.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`kpis`	No	string[]	KPI names. Omit for all.
`episodes`, `cells`, `ues`, `radios`	No	arrays	Optional filters.

get_available_results

Return the KPI catalog. Takes no parameters and does not require a workspace.

get_ue_parameters

Return UE deployment fields for completed simulations.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`parameters`	No	string[]	UE field names to return. Omit for all.
`ues`	No	string[]	UE names such as `UE_0`. Omit for all.
`episodes`	No	integer[]	Episode indices. Omit for all.

set_ue_parameter

Override one UE-side parameter before running.

Parameter	Required	Type	Description
`sim_id`	No	string	Simulation ID. Omit to use latest.
`parameter`	Yes	enum	`noise_figure_dB`, `UE_tx_power_max_dBm`, `ue_target_rate_Mbps`, `traffic_generation_model`, `category`.
`value`	Yes	number/string	Value to set or numeric delta.
`categories`	No	string[]	Apply only to matching UE categories. Omit for all UEs.
`mode`	No	enum	`set` or `delta`. Default `set`.