Skip to main content
Glama

Get GitHub Milestone Details

get_github_milestone
Read-onlyIdempotent

Retrieves detailed information for a specific GitHub milestone, including completion progress and linked issue counts, to track project status and plan work.

Instructions

Get detailed information about a specific GitHub milestone including progress and linked issue counts.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_github_milestone"
  }
}

Input Schema

NameRequiredDescriptionDefault
repoNoLEAVE EMPTY to auto-detect from git
ownerNoLEAVE EMPTY to auto-detect from git
use_test_dbNo
milestone_numberNoMilestone number

Output Schema

NameRequiredDescriptionDefault
codeNoError code (e.g. VALIDATION_ERROR, INTERNAL_ERROR)
repoNo
errorNoHuman-readable error message
ownerNo
detailsNoAdditional error context
categoryNoError category (validation, query, connection, internal)
milestoneNo
suggestionNoSuggested fix for the error
instructionNo
recoverableNoWhether the error is recoverable
detectedRepoNo
detectedOwnerNo
aggregated_errorsNoDetails of individual errors in a multi-step operation
requiresUserInputNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv9.1.0
    • changedInput schema / properties / milestone_number / type
      Previous value: -"number"New value: +[
      +  "number",
      +  "string"
      +]
  2. First observedv9.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety and network profile is covered. The description adds that progress and linked issue counts are included, which is real content beyond the annotations, but it says nothing about failure modes for a missing milestone or authentication requirements.

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

Conciseness4/5

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

A single front-loaded sentence with no wasted words. It is appropriately sized for a simple read tool, though it could have used its brevity budget to mention the sibling relationship.

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

Completeness4/5

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

An output schema exists, so return values need not be explained, and annotations cover the behavioral profile for a simple read. The remaining gap is disambiguation from get_github_milestones and get_github_milestone-adjacent mutators, plus the implicit requirement for milestone_number.

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 coverage is 75%, so most parameters are already documented, including the auto-detect semantics for repo and owner. The description adds no parameter meaning at all, and notably the schema marks no parameters required even though milestone_number is effectively mandatory for a 'specific milestone' lookup — a gap the description does not close.

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?

States a specific verb and resource ('Get detailed information about a specific GitHub milestone') and previews the payload ('progress and linked issue counts'). It does not distinguish itself from the sibling get_github_milestones or update/delete_github_milestone, so an agent must infer that this is the single-item read.

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?

There is no when-to-use guidance, no statement of prerequisites, and no reference to alternatives such as get_github_milestones for listing. The only implicit signal is the word 'specific', which hints at single-item retrieval.

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

Deploy Server

Other Tools