Get Case Actions
pega.get_case_actionsRetrieve available actions for a Pega case or fetch specific action details using a case identifier to manage case operations.
Instructions
Use this tool to discover available actions for a case or fetch a specific action definition. Required input: caseId. Optional inputs: actionId, viewType, excludeAdditionalActions, originChannel. Returns: { ok: true, data: { actions: } } on success. Standard failure format: { ok: false, error: { code, message, suggestion? } }.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseId | Yes | Unique case identifier/handle. | |
| actionId | No | Optional action identifier. When provided, returns action-level details. | |
| viewType | No | Optional view type hint used when actionId is provided. | |
| excludeAdditionalActions | No | Optional flag used with actionId to exclude additional actions from the payload. | |
| originChannel | No | Optional channel hint, for example Web or Mobile. |
Implementation Reference
- src/tools/getCaseActions.ts:16-28 (handler)The execute function that handles the tool logic for pega.get_case_actions.
execute: async ({ pegaClient }, input) => { return withCaseAccessGuard(pegaClient, input, async () => { const actions = await pegaClient.getCaseActions(input.caseId, { actionId: input.actionId, viewType: input.viewType, excludeAdditionalActions: input.excludeAdditionalActions, originChannel: input.originChannel }); return { actions }; }); } - src/tools/getCaseActions.ts:5-29 (registration)The definition of the pega.get_case_actions tool.
export const getCaseActionsToolDefinition = defineTool({ name: "pega.get_case_actions", title: "Get Case Actions", description: [ "Use this tool to discover available actions for a case or fetch a specific action definition.", "Required input: caseId.", "Optional inputs: actionId, viewType, excludeAdditionalActions, originChannel.", "Returns: { ok: true, data: { actions: <upstream payload> } } on success." ].join(" "), inputSchema: getCaseActionsSchema, invalidInputMessage: "caseId is required", execute: async ({ pegaClient }, input) => { return withCaseAccessGuard(pegaClient, input, async () => { const actions = await pegaClient.getCaseActions(input.caseId, { actionId: input.actionId, viewType: input.viewType, excludeAdditionalActions: input.excludeAdditionalActions, originChannel: input.originChannel }); return { actions }; }); } });