get_next_assignment
Retrieve the next work assignment for the current user, providing UI metadata for form or page views to facilitate task completion.
Instructions
Get detailed information about the next assignment to be performed by the requestor. Uses Get Next Work functionality to fetch the assignment most suitable for the current user.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| viewType | No | UI resources to return. "form" returns only assignment UI metadata in uiResources object, "page" returns full page (read-only review mode) UI metadata in uiResources object | page |
| pageName | No | If provided, view metadata for specific page name will be returned (only used when viewType is "page") | |
| sessionCredentials | No | Optional session-specific credentials. If not provided, uses environment variables. Supports two authentication modes: (1) OAuth mode - provide baseUrl, clientId, and clientSecret, or (2) Token mode - provide baseUrl and accessToken. |
Implementation Reference
- Main handler function executing the tool logic: parameter handling, validation, session setup, API call to pegaClient.getNextAssignment, and error handling.async execute(params) { // Handle null/undefined params const safeParams = params || {}; const { viewType = 'page', pageName } = safeParams; let sessionInfo = null; try { // Initialize session configuration if provided sessionInfo = this.initializeSessionConfig(safeParams); // Validate enum parameters using base class const enumValidation = this.validateEnumParams(safeParams, { viewType: ['form', 'page'] }); if (enumValidation) { return enumValidation; } // Validate pageName usage if (pageName && viewType !== 'page') { return { error: 'pageName parameter can only be used when viewType is set to "page".' }; } // Execute with standardized error handling return await this.executeWithErrorHandling( 'Next Assignment', async () => await this.pegaClient.getNextAssignment({ viewType, pageName }), { viewType, pageName, sessionInfo } ); } catch (error) { return { content: [{ type: 'text', text: `## Error: Next Assignment\n\n**Unexpected Error**: ${error.message}\n\n${sessionInfo ? `**Session**: ${sessionInfo.sessionId} (${sessionInfo.authMode} mode)\n` : ''}*Error occurred at: ${new Date().toISOString()}*` }] }; } }
- Tool definition for MCP including name, description, and input schema with parameters viewType, pageName, sessionCredentials.static getDefinition() { return { name: 'get_next_assignment', description: 'Get detailed information about the next assignment to be performed by the requestor. Uses Get Next Work functionality to fetch the assignment most suitable for the current user.', inputSchema: { type: 'object', properties: { viewType: { type: 'string', enum: ['form', 'page'], description: 'UI resources to return. "form" returns only assignment UI metadata in uiResources object, "page" returns full page (read-only review mode) UI metadata in uiResources object', default: 'page' }, pageName: { type: 'string', description: 'If provided, view metadata for specific page name will be returned (only used when viewType is "page")' }, sessionCredentials: getSessionCredentialsSchema() }, required: [] } }; }
- Static method declaring the tool category as 'assignments' for loader grouping.static getCategory() { return 'assignments'; }
- src/api/pega-client.js:423-425 (helper)PegaClient wrapper delegating getNextAssignment to the version-specific (v1/v2) client implementation.async getNextAssignment(options = {}) { return this.client.getNextAssignment(options); }
- src/registry/tool-registry.js:26-33 (registration)ToolRegistry initialization where configurableToolLoader.discoverTools() automatically discovers and registers all tools including get_next_assignment by scanning src/tools directories.const categories = await this.loader.discoverTools(); this.categories = categories; this.tools = this.loader.getLoadedTools(); const stats = this.loader.getStats(); console.error(`✅ Tool discovery complete:`); console.error(` - ${stats.totalTools} tools loaded`);