mcp-github-project-manager

Instructions

Implementation Reference

• src/services/ProjectManagementService.ts:422-462 (handler)

  Core implementation of getSprintMetrics: fetches sprint by ID, loads associated issues, calculates completion metrics (total/completed/remaining issues, percentage), determines days remaining and active status, optionally includes issue details.

  async getSprintMetrics(id: string, includeIssues: boolean = false): Promise<SprintMetrics> {
    try {
      const sprint = await this.sprintRepo.findById(id);
      if (!sprint) {
        throw new ResourceNotFoundError(ResourceType.SPRINT, id);
      }
  
      const issuePromises = sprint.issues.map((issueId: string) => this.issueRepo.findById(issueId));
      const issuesResult = await Promise.all(issuePromises);
      const issues = issuesResult.filter((issue: Issue | null) => issue !== null) as Issue[];
  
      const totalIssues = issues.length;
      const completedIssues = issues.filter(
        issue => issue.status === ResourceStatus.CLOSED || issue.status === ResourceStatus.COMPLETED
      ).length;
      const remainingIssues = totalIssues - completedIssues;
      const completionPercentage = totalIssues > 0 ? Math.round((completedIssues / totalIssues) * 100) : 0;
  
      const now = new Date();
      const endDate = new Date(sprint.endDate);
      const daysRemaining = Math.ceil((endDate.getTime() - now.getTime()) / (1000 * 60 * 60 * 24));
      const isActive = now >= new Date(sprint.startDate) && now <= endDate;
  
      return {
        id: sprint.id,
        title: sprint.title,
        startDate: sprint.startDate,
        endDate: sprint.endDate,
        totalIssues,
        completedIssues,
        remainingIssues,
        completionPercentage,
        status: sprint.status,
        issues: includeIssues ? issues : undefined,
        daysRemaining,
        isActive
      };
    } catch (error) {
      throw this.mapErrorToMCPError(error);
    }
  }

• src/infrastructure/tools/ToolSchemas.ts:970-984 (schema)

  Defines the ToolDefinition for get_sprint_metrics including name, description, Zod input schema (sprintId: string, includeIssues: boolean), and usage example.

  export const getSprintMetricsTool: ToolDefinition<GetSprintMetricsArgs> = {
    name: "get_sprint_metrics",
    description: "Get progress metrics for a specific sprint",
    schema: getSprintMetricsSchema as unknown as ToolSchema<GetSprintMetricsArgs>,
    examples: [
      {
        name: "Get sprint progress",
        description: "Get progress metrics for sprint 'sprint_1'",
        args: {
          sprintId: "sprint_1",
          includeIssues: true,
        },
      },
    ],
  };

• src/infrastructure/tools/ToolRegistry.ts:188-188 (registration)

  Registers the getSprintMetricsTool in the central ToolRegistry singleton during initialization.

  this.registerTool(getSprintMetricsTool);

• src/index.ts:249-250 (handler)

  MCP server request handler dispatches get_sprint_metrics calls to ProjectManagementService.getSprintMetrics after validation.

  case "get_sprint_metrics":
    return await this.service.getSprintMetrics(args.sprintId, args.includeIssues);

• src/services/ProjectManagementService.ts:110-123 (helper)

  TypeScript interface defining the structure of SprintMetrics returned by the handler.

  export interface SprintMetrics {
    id: string;
    title: string;
    startDate: string;
    endDate: string;
    totalIssues: number;
    completedIssues: number;
    remainingIssues: number;
    completionPercentage: number;
    status: ResourceStatus;
    issues?: Issue[];
    daysRemaining?: number;
    isActive: boolean;
  }