get_version_milestone_list

Retrieve version and milestone lists for Backlog projects to track project timelines and deliverables.

Instructions

Returns list of versions/milestones in the Backlog space

Input Schema

TableJSON Schema

Name	Required	Description	Default
`projectId`	No	The numeric ID of the project (e.g., 12345)
`projectKey`	No	The key of the project (e.g., TEST_PROJECT)

Implementation Reference

src/tools/getVersionMilestoneList.ts:52-62 (handler)

The handler function that executes the tool logic: resolves the project using ID or key, then fetches the list of versions/milestones using backlog.getVersions().

handler: async ({ projectId, projectKey }) => {
  const result = resolveIdOrKey(
    'project',
    { id: projectId, key: projectKey },
    t
  );
  if (!result.ok) {
    throw result.error;
  }
  return backlog.getVersions(result.value);
},

src/tools/getVersionMilestoneList.ts:8-27 (schema)

Input schema definition using Zod: optional projectId (number) or projectKey (string).

const getVersionMilestoneListSchema = buildToolSchema((t) => ({
  projectId: z
    .number()
    .optional()
    .describe(
      t(
        'TOOL_GET_VERSION_MILESTONE_PROJECT_ID',
        'The numeric ID of the project (e.g., 12345)'
      )
    ),
  projectKey: z
    .string()
    .optional()
    .describe(
      t(
        'TOOL_GET_VERSION_MILESTONE_PROJECT_KEY',
        'The key of the project (e.g., TEST_PROJECT)'
      )
    ),
}));

src/tools/getVersionMilestoneList.ts:36-63 (registration)

Tool definition and registration within the exported getVersionMilestoneListTool function, including name, description, schemas, important fields, and handler.

return {
  name: 'get_version_milestone_list',
  description: t(
    'TOOL_GET_VERSION_MILESTONE_LIST_DESCRIPTION',
    'Returns list of versions/milestones in the Backlog space'
  ),
  schema: z.object(getVersionMilestoneListSchema(t)),
  outputSchema: VersionSchema,
  importantFields: [
    'id',
    'name',
    'description',
    'startDate',
    'releaseDueDate',
    'archived',
  ],
  handler: async ({ projectId, projectKey }) => {
    const result = resolveIdOrKey(
      'project',
      { id: projectId, key: projectKey },
      t
    );
    if (!result.ok) {
      throw result.error;
    }
    return backlog.getVersions(result.value);
  },
};

src/tools/tools.ts:112-112 (registration)
Final registration: adds the tool to the 'issue' toolset group in the allTools export.
```
getVersionMilestoneListTool(backlog, helper),
```
src/tools/tools.ts:53-53 (registration)
Import of the getVersionMilestoneListTool for use in the toolset.
```
import { getVersionMilestoneListTool } from './getVersionMilestoneList.js';
```

Backlog MCP Server