Skip to main content
Glama
fleagne

Backlog MCP Server

by fleagne

backlog_update_issue

Modify project issue details in Backlog by updating attributes such as status, assignee, due date, or description using the Backlog API. Streamline issue management with structured inputs for efficient project tracking.

Instructions

Update an issue using the Backlog Issue API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actualHoursNoActual hours
assigneeIdNoAssignee id
attachmentIdNoAttachment ids
categoryIdNoCategory ids
commentNoComment
descriptionNoDescription
dueDateNoDue date
estimatedHoursNoEstimated hours
issueIdOrKeyYesIssue ID or Issue Key
issueTypeIdNoIssue type id
milestoneIdNoMilestone ids
notifiedUserIdNoNotified user ids
parentIssueIdNoParent issue id
priorityIdNoPriority id
startDateNoStart date
statusIdNoStatus id
summaryNoSummary
versionIdNoVersion ids

Implementation Reference

  • Main execution handler for 'backlog_update_issue' tool: parses args with schema, calls issueService.updateIssue, returns formatted response or error.
    const handleUpdateIssue: ToolHandler = async (args) => {
    	try {
    		try {
    			const validatedParams = UpdateIssueParamsSchema.parse(args);
    
    			const text = await issueService.updateIssue(validatedParams);
    
    			return {
    				content: [
    					{
    						type: "text",
    						text: `Results for your query:\n${text}`,
    					},
    				],
    				isError: false,
    			};
    		} catch (validationError) {
    			throw new ValidationError(
    				`Invalid parameters: ${validationError instanceof Error ? validationError.message : String(validationError)}`,
    			);
    		}
    	} catch (error) {
    		return {
    			content: [
    				{
    					type: "text",
    					text: `Error: ${formatError(error)}`,
    				},
    			],
    			isError: true,
    		};
    	}
    };
  • Zod input schema definition for validating parameters of the backlog_update_issue tool, including issueIdOrKey (required) and various optional update fields.
    export const UpdateIssueParamsSchema = z.object({
    	issueIdOrKey: z.string().describe("Issue ID or Issue Key"),
    	summary: z.string().optional().describe("Summary"),
    	parentIssueId: z.number().int().optional().describe("Parent issue id"),
    	description: z.string().optional().describe("Description"),
    	statusId: z.number().int().optional().describe("Status id"),
    	startDate: z.string().optional().describe("Start date"),
    	dueDate: z.string().optional().describe("Due date"),
    	estimatedHours: z.number().optional().describe("Estimated hours"),
    	actualHours: z.number().optional().describe("Actual hours"),
    	issueTypeId: z.number().int().optional().describe("Issue type id"),
    	categoryId: z.array(z.number()).optional().describe("Category ids"),
    	versionId: z.array(z.number()).optional().describe("Version ids"),
    	milestoneId: z.array(z.number()).optional().describe("Milestone ids"),
    	priorityId: z.number().int().optional().describe("Priority id"),
    	assigneeId: z.number().int().optional().describe("Assignee id"),
    	notifiedUserId: z.array(z.number()).optional().describe("Notified user ids"),
    	attachmentId: z.array(z.number()).optional().describe("Attachment ids"),
    	comment: z.string().optional().describe("Comment"),
    });
  • Maps the tool name 'backlog_update_issue' to its handler function handleUpdateIssue in the central toolHandlers registry.
    export const toolHandlers: Record<ToolName, ToolHandler> = {
    	backlog_get_projects: handleGetProjects,
    	backlog_get_project: handleGetProject,
    	backlog_get_issues: handleGetIssues,
    	backlog_get_issue: handleGetIssue,
    	backlog_add_issue: handleAddIssue,
    	backlog_update_issue: handleUpdateIssue,
    	backlog_delete_issue: handleDeleteIssue,
    	backlog_get_wikis: handleGetWikis,
    	backlog_get_wiki: handleGetWiki,
    	backlog_add_wiki: handleAddWiki,
    	backlog_update_wiki: handleUpdateWiki,
    	backlog_delete_wiki: handleDeleteWiki,
    };
  • Defines the MCP Tool object for 'backlog_update_issue' with description and inputSchema derived from UpdateIssueParamsSchema.
    export const UPDATE_ISSUE_TOOL: Tool = createTool(
    	"backlog_update_issue",
    	"Update an issue using the Backlog Issue API.",
    	UpdateIssueParamsSchema,
    );
  • TypeScript union type including 'backlog_update_issue' for type-safe tool names.
    export type ToolName =
    	| "backlog_get_projects"
    	| "backlog_get_project"
    	| "backlog_get_issues"
    	| "backlog_get_issue"
    	| "backlog_add_issue"
    	| "backlog_update_issue"
    	| "backlog_delete_issue"
    	| "backlog_get_wikis"
    	| "backlog_get_wiki"
    	| "backlog_add_wiki"
    	| "backlog_update_wiki"
    	| "backlog_delete_wiki";

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden. It does not disclose behavioral traits such as whether updates are partial or full, side effects like notifications, or error conditions. The phrase 'Update an issue' is vague.

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

Conciseness3/5

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

The description is one sentence, making it concise. However, it is too minimal and could be more informative while still being concise. It earns its place but lacks depth.

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 (18 parameters, no output schema), the description is insufficient. It does not explain overall behavior, required fields beyond issueIdOrKey, or constraints. More context is needed for effective use.

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 100%, so the baseline is 3. The description adds no extra meaning beyond the schema's parameter descriptions. It does not clarify dependencies or formatting beyond what is in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Update' and the resource 'an issue', and specifies the API source 'Backlog Issue API'. It is distinct from sibling tools like backlog_add_issue, backlog_get_issue, and backlog_delete_issue.

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?

No guidance is provided on when to use this tool, preconditions, or when not to use it. The description lacks context about alternatives or scenarios for updating vs. other operations.

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

Related Tools