Skip to main content
Glama

update_sprint

Modify sprint details including title, description, dates, and status to track development progress in GitHub projects.

Instructions

Update a development sprint

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sprintIdYes
titleNo
descriptionNo
startDateNo
endDateNo
statusNo

Implementation Reference

  • Main handler function for update_sprint tool. Maps tool arguments to domain model, handles status enum conversion, cleans undefined fields, and delegates to GitHubSprintRepository.update
    async updateSprint(data: {
      sprintId: string;
      title?: string;
      description?: string;
      startDate?: string;
      endDate?: string;
      status?: 'planned' | 'active' | 'completed';
      issues?: string[];
    }): Promise<Sprint> {
      try {
        // Convert status string to ResourceStatus enum if provided
        let resourceStatus: ResourceStatus | undefined;
        if (data.status) {
          switch (data.status) {
            case 'planned':
              resourceStatus = ResourceStatus.PLANNED;
              break;
            case 'active':
              resourceStatus = ResourceStatus.ACTIVE;
              break;
            case 'completed':
              resourceStatus = ResourceStatus.CLOSED;
              break;
          }
        }
    
        // Map input data to domain model
        const sprintData: Partial<Sprint> = {
          title: data.title,
          description: data.description,
          startDate: data.startDate,
          endDate: data.endDate,
          status: resourceStatus,
          issues: data.issues
        };
    
        // Clean up undefined values
        Object.keys(sprintData).forEach(key => {
          if (sprintData[key as keyof Partial<Sprint>] === undefined) {
            delete sprintData[key as keyof Partial<Sprint>];
          }
        });
    
        return await this.sprintRepo.update(data.sprintId, sprintData);
      } catch (error) {
        throw this.mapErrorToMCPError(error);
      }
    }
  • Zod schema definition for update_sprint tool input validation
    // Schema for update_sprint tool
    export const updateSprintSchema = z.object({
      sprintId: z.string().min(1, "Sprint ID is required"),
      title: z.string().optional(),
      description: z.string().optional(),
      startDate: z.string().datetime().optional(),
      endDate: z.string().datetime().optional(),
      status: z.enum(["planned", "active", "completed"]).optional(),
    });
    
    export type UpdateSprintArgs = z.infer<typeof updateSprintSchema>;
  • Registration of update_sprint tool (as updateSprintTool) in the central ToolRegistry
    this.registerTool(createSprintTool);
    this.registerTool(listSprintsTool);
    this.registerTool(getCurrentSprintTool);
    this.registerTool(updateSprintTool);
    this.registerTool(addIssuesToSprintTool);
    this.registerTool(removeIssuesFromSprintTool);
  • src/index.ts:304-305 (registration)
    Dispatch handler in main MCP server that routes update_sprint calls to ProjectManagementService.updateSprint
    case "update_sprint":
      return await this.service.updateSprint(args);
  • ToolDefinition export for update_sprint including name, description, schema reference, and usage examples
    export const updateSprintTool: ToolDefinition<UpdateSprintArgs> = {
      name: "update_sprint",
      description: "Update a development sprint",
      schema: updateSprintSchema as unknown as ToolSchema<UpdateSprintArgs>,
      examples: [
        {
          name: "Update sprint dates",
          description: "Update sprint dates and status",
          args: {
            sprintId: "sprint_1",
            startDate: "2025-07-01T00:00:00Z",
            endDate: "2025-07-15T00:00:00Z",
            status: "active"
          }
        }
      ]
    };
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states 'Update' implies a mutation, but doesn't specify required permissions, whether changes are reversible, error handling, or response format. For a mutation tool with 6 parameters, 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 with no wasted words. It's appropriately sized for a basic purpose statement, though its brevity contributes to gaps in other dimensions.

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 (mutation tool with 6 parameters), lack of annotations, 0% schema description coverage, and no output schema, the description is incomplete. It doesn't explain what the tool returns, how parameters interact, or behavioral aspects, making it inadequate for reliable agent use.

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

Parameters2/5

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

Schema description coverage is 0%, so the schema provides no parameter documentation. The description doesn't mention any parameters, leaving all 6 parameters (sprintId, title, description, startDate, endDate, status) undocumented. This fails to compensate for the schema's lack of descriptions.

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

Purpose3/5

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

The description 'Update a development sprint' clearly states the verb ('Update') and resource ('development sprint'), making the purpose understandable. However, it lacks specificity about what aspects can be updated and doesn't distinguish it from sibling tools like 'update_issue' or 'update_milestone', which have similar update operations on different resources.

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 (e.g., needing an existing sprint), exclusions, or compare it to related tools like 'create_sprint' or 'plan_sprint'. This leaves the agent without context for appropriate 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

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/HarshKumarSharma/MCP'

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