Skip to main content
Glama

get_current_sprint

Retrieve the active sprint details from GitHub projects to track current development progress and manage project timelines effectively.

Instructions

Get the currently active sprint

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeIssuesYes

Implementation Reference

  • Main handler function that implements the core logic: finds the currently active sprint using sprintRepo.findCurrent() and optionally fetches and attaches issue details.
    async getCurrentSprint(includeIssues: boolean = true): Promise<Sprint | null> {
      try {
        const currentSprint = await this.sprintRepo.findCurrent();
    
        if (!currentSprint) {
          return null;
        }
    
        if (includeIssues) {
          // Add issues data to sprint
          const issues = await this.sprintRepo.getIssues(currentSprint.id);
    
          // We can't modify the sprint directly, so we create a new object
          return {
            ...currentSprint,
            // We're adding this property outside the type definition for convenience
            // in the response; it won't affect the actual sprint object
            issueDetails: issues
          } as Sprint & { issueDetails?: Issue[] };
        }
    
        return currentSprint;
      } catch (error) {
        throw this.mapErrorToMCPError(error);
      }
    }
  • Tool dispatch handler in the main MCP server switch statement that receives validated args and delegates to ProjectManagementService.getCurrentSprint()
    case "get_current_sprint":
      return await this.service.getCurrentSprint(args.includeIssues);
  • Zod schema defining the tool input parameters: optional boolean includeIssues (defaults to true)
    // Schema for get_current_sprint tool
    export const getCurrentSprintSchema = z.object({
      includeIssues: z.boolean().default(true),
    });
    
    export type GetCurrentSprintArgs = z.infer<typeof getCurrentSprintSchema>;
  • Registers the getCurrentSprintTool in the central ToolRegistry for MCP tool listing
    this.registerTool(getCurrentSprintTool);
  • ToolDefinition object defining name, description, schema reference, and usage examples for MCP tool discovery.
    export const getCurrentSprintTool: ToolDefinition<GetCurrentSprintArgs> = {
      name: "get_current_sprint",
      description: "Get the currently active sprint",
      schema: getCurrentSprintSchema as unknown as ToolSchema<GetCurrentSprintArgs>,
      examples: [
        {
          name: "Get current sprint with issues",
          description: "Get details of the current sprint including assigned issues",
          args: {
            includeIssues: true
          }
        }
      ]
    };
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 this is a 'Get' operation, implying it's likely read-only, but doesn't confirm this or describe any other behavioral traits like authentication needs, rate limits, error conditions, or what 'active' means in this context. The description is too minimal for a tool with parameters.

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, clear sentence with no wasted words. It's front-loaded with the core purpose and appropriately sized for what it conveys, though it lacks necessary detail for full tool understanding.

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 tool has one undocumented parameter, no annotations, and no output schema, the description is incomplete. It doesn't explain what 'includeIssues' does, what the return value looks like, or any behavioral context needed for proper tool invocation in a system with many sibling sprint-related tools.

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

Parameters1/5

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

The input schema has one required parameter 'includeIssues' with 0% description coverage in the schema, and the tool description provides no information about parameters. The description doesn't mention 'includeIssues' at all, leaving the parameter completely undocumented and unexplained.

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 'Get the currently active sprint' clearly states the verb ('Get') and resource ('currently active sprint'), making the tool's purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'get_sprint_metrics' or 'list_sprints' that might also retrieve sprint information, preventing a perfect score.

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 like 'get_sprint_metrics' or 'list_sprints'. It doesn't mention prerequisites, exclusions, or specific contexts where this tool is preferred, leaving the agent to infer usage from the name alone.

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