get_simulation
Retrieve a simulation configuration from Paddle Billing using its unique ID to access setup details and parameters.
Instructions
This tool will retrieve a simulation from Paddle by its ID.
This is for the configuration of a simulation, as opposed to the simulation run which is used to send the events to the notification destination.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| simulationId | Yes | Paddle ID of the simulation entity. |
Implementation Reference
- src/functions.ts:588-596 (handler)The core handler function for the 'get_simulation' tool. It takes a Paddle instance and parameters, extracts simulationId, calls paddle.simulations.get(simulationId), and returns the simulation or error.
export const getSimulation = async (paddle: Paddle, params: z.infer<typeof Parameters.getSimulationParameters>) => { try { const { simulationId } = params; const simulation = await paddle.simulations.get(simulationId); return simulation; } catch (error) { return error; } }; - src/tools.ts:830-840 (schema)The MCP tool schema definition for 'get_simulation', including method name, description prompt reference, input parameters schema reference (params.getSimulationParameters), and required actions/permissions.
method: "get_simulation", name: "Get a simulation", description: prompts.getSimulationPrompt, parameters: params.getSimulationParameters, actions: { simulations: { read: true, get: true, }, }, }, - src/api.ts:57-57 (registration)Registration of the getSimulation handler in the toolMap used by PaddleAPI.run() to dispatch tool calls to the correct function.
[TOOL_METHODS.GET_SIMULATION]: funcs.getSimulation, - src/tools.ts:1021-1023 (registration)Export of the full tools array which includes the 'get_simulation' tool definition, serving as the primary MCP tools registration.
]; export default tools; - src/constants.ts:49-49 (helper)Constant definition for the tool method name string used in TOOL_METHODS and registrations.
GET_SIMULATION: "get_simulation",