Skip to main content
Glama
Hive-Academy

π“‚€π“’π“‹Ήπ”Έβ„•π•Œπ”Ήπ•€π•Šπ“‹Ήπ“’π“‚€ - Intelligent Guidance for

by Hive-Academy

get_step_progress

Track and retrieve detailed progress summaries for specific tasks using a task ID. Optional role ID filtering enhances task management and focus.

Instructions

Get focused step progress summary for a task.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesTask ID for progress query
roleIdNoOptional role ID filter

Implementation Reference

  • The main handler function for the 'get_step_progress' MCP tool. It fetches execution details, step progress records, computes progress metrics, and returns a structured response with current step status, progress percentage, and summary of last completed step.
    async getStepProgress(input: GetStepProgressInput) {
      try {
        // βœ… CRITICAL FIX: Use executionId for progress tracking instead of taskId
        const executionResult =
          await this.workflowExecutionOperationsService.getExecution({
            executionId: input.executionId,
          });
    
        if (!executionResult.execution) {
          return this.buildResponse({
            executionId: input.executionId,
            status: 'no_execution',
            error: 'No execution found for provided executionId',
          });
        }
    
        const execution = executionResult.execution;
    
        // Get only essential step progress data
        const stepProgressRepository =
          this.stepExecutionService['stepProgressRepository'];
        const stepProgressRecords =
          await stepProgressRepository.findByExecutionId(input.executionId);
    
        // Count completed steps and get most recent
        const completedSteps = stepProgressRecords.filter(
          (record) => record.status === 'COMPLETED',
        );
        const mostRecentStep = completedSteps[0] || null;
    
        const currentStep = execution.currentStep;
        const currentRole = execution.currentRole;
    
        return this.buildResponse({
          executionId: input.executionId,
          taskId: execution.taskId,
          status: execution.completedAt ? 'completed' : 'in_progress',
    
          // Current execution state
          currentStep: {
            id: currentStep?.id,
            name: currentStep?.name || 'No current step',
            status: execution.completedAt ? 'completed' : 'active',
            roleId: execution.currentRoleId,
            roleName: currentRole?.name || 'Unknown',
          },
    
          // Essential progress metrics
          progress: {
            stepsCompleted:
              completedSteps.length || execution.stepsCompleted || 0,
            progressPercentage: execution.progressPercentage || 0,
            totalSteps: execution.totalSteps || 0,
          },
    
          // Minimal execution context
          executionContext: {
            phase: (execution.executionState as any)?.phase || 'unknown',
            executionMode: execution.executionMode,
            startedAt: execution.startedAt,
            completedAt: execution.completedAt,
          },
    
          // Essential summary only
          summary: {
            totalStepsCompleted: completedSteps.length,
            lastCompletedStep: mostRecentStep
              ? {
                  stepName: mostRecentStep.step?.name || 'Unknown',
                  roleName: mostRecentStep.role?.name || 'Unknown',
                  completedAt: mostRecentStep.completedAt,
                  summary:
                    (mostRecentStep.executionData as any)?.outputSummary ||
                    'No summary available',
                }
              : null,
            isReady: Boolean(currentStep && !execution.completedAt),
          },
        });
      } catch (error) {
        return this.buildErrorResponse(
          'Failed to get step progress',
          getErrorMessage(error),
          'STEP_PROGRESS_ERROR',
        );
      }
    }
  • Registration of the 'get_step_progress' tool using the @Tool decorator, specifying name, description, and input schema.
    @Tool({
      name: 'get_step_progress',
      description: `Get concise step progress focused on essential status information for workflow continuation.`,
      parameters: GetStepProgressInputSchema as ZodSchema<GetStepProgressInput>,
    })
  • Zod schema definition for the input parameters of the get_step_progress tool (executionId required, roleId optional) and its TypeScript type inference.
    const GetStepProgressInputSchema = z.object({
      executionId: z.string().describe('Execution ID for progress query'),
      roleId: z.string().optional().describe('Optional role ID filter'),
    });
    
    type GetStepGuidanceInput = z.infer<typeof GetStepGuidanceInputSchema>;
    type ReportStepCompletionInput = z.infer<
      typeof ReportStepCompletionInputSchema
    >;
    type GetStepProgressInput = z.infer<typeof GetStepProgressInputSchema>;
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Get' implies a read operation, but doesn't specify if it's safe, requires permissions, has rate limits, or what the output format might be. For a tool with no annotations, this is a significant gap in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without any wasted words. It's appropriately sized and front-loaded, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of task progress tools and the lack of annotations and output schema, the description is incomplete. It doesn't explain what 'focused step progress summary' means, how results are returned, or any behavioral traits, leaving the agent with insufficient context for reliable use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents both parameters ('id' and 'roleId') with descriptions. The description adds no additional meaning beyond what the schema provides, such as explaining what 'focused step progress summary' entails in relation to parameters. Baseline 3 is appropriate when schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Get') and resource ('focused step progress summary for a task'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_step_guidance' or 'get_next_available_step', which might also relate to task steps, so it lacks sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, context, or exclusions, leaving the agent to infer usage based on the name alone, which is insufficient for effective tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Hive-Academy/Anubis-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server