Skip to main content
Glama

list_sprints

Retrieve all sprints from GitHub projects to track development progress and manage workflows based on status.

Instructions

List all sprints

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes

Implementation Reference

  • Core handler function that fetches all sprints from the GitHubSprintRepository and filters them by the provided status ('planned', 'active', 'completed', or 'all'). Maps status strings to ResourceStatus enum and handles errors.
    async listSprints(status: string = 'all'): Promise<Sprint[]> {
      try {
        const sprints = await this.sprintRepo.findAll();
    
        // Filter by status if needed
        if (status !== 'all') {
          let resourceStatus;
          switch(status) {
            case 'planned':
              resourceStatus = ResourceStatus.PLANNED;
              break;
            case 'active':
              resourceStatus = ResourceStatus.ACTIVE;
              break;
            case 'completed':
              resourceStatus = ResourceStatus.COMPLETED;
              break;
            default:
              return sprints;
          }
    
          return sprints.filter(sprint => sprint.status === resourceStatus);
        }
    
        return sprints;
      } catch (error) {
        throw this.mapErrorToMCPError(error);
      }
    }
  • Zod schema definition for list_sprints tool input, validating optional 'status' parameter with enum values.
    // Schema for list_sprints tool
    export const listSprintsSchema = z.object({
      status: z.enum(["planned", "active", "completed", "all"]).default("all"),
    });
    
    export type ListSprintsArgs = z.infer<typeof listSprintsSchema>;
  • ToolDefinition for list_sprints including name, description, schema reference, and usage examples.
    export const listSprintsTool: ToolDefinition<ListSprintsArgs> = {
      name: "list_sprints",
      description: "List all sprints",
      schema: listSprintsSchema as unknown as ToolSchema<ListSprintsArgs>,
      examples: [
        {
          name: "List active sprints",
          description: "List all currently active sprints",
          args: {
            status: "active"
          }
        }
      ]
    };
  • Registers the listSprintsTool in the central ToolRegistry singleton instance.
    this.registerTool(listSprintsTool);
  • MCP tool dispatcher switch case that routes list_sprints calls to ProjectManagementService.listSprints.
    case "list_sprints":
      return await this.service.listSprints(args.status);
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. 'List all sprints' implies a read-only operation, but it doesn't specify if it requires authentication, how results are returned (e.g., pagination, sorting), or any rate limits. This leaves significant gaps in understanding the tool's behavior beyond the basic action.

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 extremely concise with just three words, front-loading the core action and resource. There is no wasted language, making it efficient and easy to parse, though this 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 tool's complexity (a list operation with 1 required parameter), no annotations, no output schema, and low schema coverage (0%), the description is incomplete. It doesn't explain the parameter, return format, or behavioral aspects, making it inadequate for effective tool selection and invocation.

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?

The input schema has 1 required parameter ('status') with 0% description coverage, meaning the parameter is undocumented in the schema. The description 'List all sprints' doesn't mention any parameters or explain what 'status' means (e.g., possible values like 'active', 'completed'), failing to compensate for the low schema coverage.

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 'List all sprints' clearly states the verb ('List') and resource ('sprints'), making the basic purpose understandable. However, it doesn't specify what constitutes 'all' (e.g., active, completed, all statuses) or differentiate from sibling tools like 'get_current_sprint' or 'get_sprint_metrics', leaving it vague about scope and distinction.

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 sibling tools like 'get_current_sprint' for current sprint data or 'get_sprint_metrics' for performance insights, nor does it indicate any prerequisites or exclusions for usage.

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