Skip to main content
Glama
jootsuki

Backlog MCP Server

by jootsuki

updateIssue

Modify Backlog issue details including status, description, and comments using the issue ID to track project tasks.

Instructions

Backlog課題を更新します

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
issueIdYes課題のID(例: PROJECT-1)
statusNo新しいステータス
descriptionNo課題の説明
commentNo更新時のコメント

Implementation Reference

  • Core handler function that performs the PATCH request to update a Backlog issue using the provided arguments.
    async updateIssue(args: UpdateIssueArgs): Promise<BacklogIssue> {
      try {
        const params: Record<string, any> = {};
    
        if (args.status) {
          params.statusId = this.getStatusId(args.status);
        }
    
        if (args.comment) {
          params.comment = args.comment;
        }
    
        if (args.description !== undefined) {
          params.description = args.description;
        }
    
        const response = await this.client.patch(`/issues/${args.issueId}`, params);
        return response.data;
      } catch (error) {
        if (axios.isAxiosError(error)) {
          throw new Error(`Backlog API error: ${error.response?.data.message ?? error.message}`);
        }
        throw error;
      }
    }
  • MCP server handler for the 'updateIssue' tool call, which validates arguments and delegates to BacklogClient.updateIssue.
    case 'updateIssue': {
      const args = this.validateAndCastArguments<UpdateIssueArgs>(
        request.params.arguments,
        updateIssueSchema
      );
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(
              await this.backlogClient.updateIssue(args),
              null,
              2
            ),
          },
        ],
      };
    }
  • src/index.ts:99-103 (registration)
    Registration of the 'updateIssue' tool in the ListTools response, including name, description, and input schema.
    {
      name: 'updateIssue',
      description: 'Backlog課題を更新します',
      inputSchema: updateIssueSchema,
    },
  • Input schema definition for the updateIssue tool, used for validation.
    export const updateIssueSchema = {
      type: 'object',
      properties: {
        issueId: {
          type: 'string',
          description: '課題のID(例: PROJECT-1)',
        },
        status: {
          type: 'string',
          description: '新しいステータス',
        },
        description: {
          type: 'string',
          description: '課題の説明',
        },
        comment: {
          type: 'string',
          description: '更新時のコメント',
        },
      },
      required: ['issueId'],
    } as const;
  • TypeScript interface defining the arguments for updateIssue.
    export interface UpdateIssueArgs {
      issueId: string;
      status?: string;
      description?: string;
      comment?: string;
    }
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. It states the tool updates an issue, implying a mutation, but doesn't disclose any behavioral traits like required permissions, whether changes are reversible, rate limits, or what the response looks like. This is a significant gap for a mutation tool with zero annotation coverage.

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 a single, efficient sentence ('Backlog課題を更新します') that is appropriately sized and front-loaded, with zero waste. It directly states the tool's purpose without unnecessary elaboration.

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 complexity of a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain the return values, error conditions, or behavioral context, leaving the agent with insufficient information to use the tool effectively beyond basic parameter input.

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?

The input schema has 100% description coverage, with all parameters documented in the schema itself (e.g., 'issueId' as the issue ID, 'status' as new status). The description adds no additional meaning beyond what the schema provides, such as explaining how parameters interact or providing examples beyond the schema's '例: PROJECT-1'. Baseline 3 is appropriate when the schema does the heavy lifting.

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 'Backlog課題を更新します' (Updates a Backlog issue) clearly states the verb ('更新します' - updates) and resource ('Backlog課題' - Backlog issue), providing a basic purpose. However, it doesn't distinguish this from potential sibling tools like 'getIssue' or 'searchIssues' beyond the update action, making it somewhat vague in differentiation.

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 like 'getIssue' or 'searchIssues'. It lacks any mention of prerequisites, such as needing an existing issue ID, or exclusions, leaving the agent to infer usage from the tool name alone.

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/jootsuki/backlog-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server