backlog_update

Instructions

Implementation Reference

• packages/server/src/tools/backlog-update.ts:24-55 (handler)

  Core handler function that executes the backlog_update tool logic. Retrieves the task, updates fields (handling parent_id/epic_id precedence, nullable fields), applies updates, saves to storage, and returns success/error response.

  async ({ id, epic_id, parent_id, due_date, content_type, ...updates }) => {
    const task = storage.get(id);
    if (!task) return { content: [{ type: 'text', text: `Task ${id} not found` }], isError: true };
  
    // parent_id takes precedence over epic_id
    if (parent_id !== undefined) {
      if (parent_id === null) {
        delete task.parent_id;
        delete task.epic_id;
      } else {
        task.parent_id = parent_id;
      }
    } else if (epic_id !== undefined) {
      if (epic_id === null) {
        delete task.epic_id;
        delete task.parent_id;
      } else {
        task.epic_id = epic_id;
        task.parent_id = epic_id;
      }
    }
  
    // Nullable type-specific fields: null clears, string sets
    for (const [key, val] of Object.entries({ due_date, content_type })) {
      if (val === null) delete (task as any)[key];
      else if (val !== undefined) (task as any)[key] = val;
    }
  
    Object.assign(task, updates, { updated_at: new Date().toISOString() });
    storage.save(task);
    return { content: [{ type: 'text', text: `Updated ${id}` }] };
  }

• packages/server/src/tools/backlog-update.ts:11-22 (schema)

  Zod input schema definition for the backlog_update tool, validating parameters including id, title, status, epic_id, parent_id, blocked_reason, evidence, references, due_date, and content_type.

  inputSchema: z.object({
    id: z.string().describe('Task ID to update'),
    title: z.string().optional().describe('New title'),
    status: z.enum(STATUSES).optional().describe('New status'),
    epic_id: z.union([z.string(), z.null()]).optional().describe('Parent epic ID (null to unlink)'),
    parent_id: z.union([z.string(), z.null()]).optional().describe('Parent ID (null to unlink). Takes precedence over epic_id.'),
    blocked_reason: z.array(z.string()).optional().describe('Reason if status is blocked'),
    evidence: z.array(z.string()).optional().describe('Proof of completion when marking done - links to PRs, docs, or notes'),
    references: z.array(z.object({ url: z.string(), title: z.string().optional() })).optional().describe('Reference links. Formats: external URLs (https://...), task refs (mcp://backlog/tasks/TASK-XXXX.md), resources (mcp://backlog/resources/{path}). Local files must include extension (file:///path/to/file.md)'),
    due_date: z.union([z.string(), z.null()]).optional().describe('Due date for milestones (ISO 8601). Null to clear.'),
    content_type: z.union([z.string(), z.null()]).optional().describe('Content type for artifacts (e.g. text/markdown). Null to clear.'),
  }),

• packages/server/src/tools/backlog-update.ts:6-23 (registration)

  Tool registration function that registers the backlog_update tool with the MCP server, including description, input schema, and handler callback.

  export function registerBacklogUpdateTool(server: McpServer) {
    server.registerTool(
      'backlog_update',
      {
        description: 'Update an existing item. For editing the markdown body, use write_resource with str_replace.',
        inputSchema: z.object({
          id: z.string().describe('Task ID to update'),
          title: z.string().optional().describe('New title'),
          status: z.enum(STATUSES).optional().describe('New status'),
          epic_id: z.union([z.string(), z.null()]).optional().describe('Parent epic ID (null to unlink)'),
          parent_id: z.union([z.string(), z.null()]).optional().describe('Parent ID (null to unlink). Takes precedence over epic_id.'),
          blocked_reason: z.array(z.string()).optional().describe('Reason if status is blocked'),
          evidence: z.array(z.string()).optional().describe('Proof of completion when marking done - links to PRs, docs, or notes'),
          references: z.array(z.object({ url: z.string(), title: z.string().optional() })).optional().describe('Reference links. Formats: external URLs (https://...), task refs (mcp://backlog/tasks/TASK-XXXX.md), resources (mcp://backlog/resources/{path}). Local files must include extension (file:///path/to/file.md)'),
          due_date: z.union([z.string(), z.null()]).optional().describe('Due date for milestones (ISO 8601). Null to clear.'),
          content_type: z.union([z.string(), z.null()]).optional().describe('Content type for artifacts (e.g. text/markdown). Null to clear.'),
        }),
      },

• packages/server/src/tools/index.ts:14-14 (registration)

  Registration call in the tools index that invokes registerBacklogUpdateTool to register the backlog_update tool with the server.

  registerBacklogUpdateTool(server);

• packages/shared/src/entity-types.ts:31-32 (schema)

  STATUSES constant and Status type definition used by the backlog_update schema to validate the status field (values: open, in_progress, blocked, done, cancelled).

  export const STATUSES = ['open', 'in_progress', 'blocked', 'done', 'cancelled'] as const;
  export type Status = (typeof STATUSES)[number];