Skip to main content
Glama

update-issue

Modify existing project issues by updating titles, descriptions, priorities, states, or assignees to keep project management current and organized.

Instructions

Update an existing issue in a project, delete just update the issue title with 'delete' or 'remove'

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesID of the project containing the issue
issue_idYesID of the issue to update
nameNoUpdated title of the issue (optional)
description_htmlNoHTML description of the issue (required by Plane API)
priorityNoUpdated priority of the issue (optional)
state_idNoUpdated state ID of the issue (optional)
assigneesNoUpdated array of user IDs to assign to this issue (optional)

Implementation Reference

  • The main handler function for the 'update-issue' tool. It validates inputs, normalizes assignees array, and calls the Plane API with PATCH to update the issue.
    case "update-issue": {
      if (
        !args ||
        typeof args.project_id !== "string" ||
        typeof args.issue_id !== "string"
      ) {
        throw new Error("Project ID and Issue ID are required");
      }
      const { project_id, issue_id, ...updateData } = args;
    
      // Ensure assignees is properly formatted as an array
      if (updateData.assignees) {
        // Special case: detect if entire issue is nested in assignees
        if (
          typeof updateData.assignees === "object" &&
          !Array.isArray(updateData.assignees) &&
          (updateData.assignees as Record<string, any>).project_id &&
          (updateData.assignees as Record<string, any>).name
        ) {
          // Issue is nested inside assignees, remove it completely
          delete updateData.assignees;
        } else if (!Array.isArray(updateData.assignees)) {
          if (typeof updateData.assignees === "string") {
            // Convert single string to array
            updateData.assignees = [updateData.assignees];
          } else if (typeof updateData.assignees === "object") {
            // Convert object to array of values
            updateData.assignees = Object.values(updateData.assignees);
          } else {
            // Remove invalid assignees
            delete updateData.assignees;
          }
        }
      }
    
      const updatedIssue = await callPlaneAPI(
        `/projects/${project_id}/issues/${issue_id}/`,
        "PATCH",
        updateData
      );
      return {
        content: [
          { type: "text", text: JSON.stringify(updatedIssue, null, 2) },
        ],
        isError: false,
      };
    }
  • Tool schema definition including name, description, and input schema for validating parameters like project_id, issue_id, name, etc.
    const UPDATE_ISSUE_TOOL: Tool = {
      name: "update-issue",
      description:
        "Update an existing issue in a project, delete just update the issue title with 'delete' or 'remove'",
      inputSchema: {
        type: "object",
        properties: {
          project_id: {
            type: "string",
            description: "ID of the project containing the issue",
          },
          issue_id: {
            type: "string",
            description: "ID of the issue to update",
          },
          name: {
            type: "string",
            description: "Updated title of the issue (optional)",
          },
          description_html: {
            type: "string",
            description: "HTML description of the issue (required by Plane API)",
          },
          priority: {
            type: "string",
            description: "Updated priority of the issue (optional)",
            enum: ["urgent", "high", "medium", "low", "none"],
          },
          state_id: {
            type: "string",
            description: "Updated state ID of the issue (optional)",
          },
          assignees: {
            type: "array",
            items: {
              type: "string",
            },
            description:
              "Updated array of user IDs to assign to this issue (optional)",
          },
        },
        required: ["project_id", "issue_id"],
      },
    };
  • src/index.ts:262-271 (registration)
    Registration of the 'update-issue' tool (as UPDATE_ISSUE_TOOL) in the list of available tools returned by the listTools handler.
    server.setRequestHandler(ListToolsRequestSchema, async () => ({
      tools: [
        LIST_PROJECTS_TOOL,
        GET_PROJECT_TOOL,
        CREATE_ISSUE_TOOL,
        LIST_ISSUES_TOOL,
        GET_ISSUE_TOOL,
        UPDATE_ISSUE_TOOL,
      ],
    }));
Behavior2/5

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

With no annotations provided, the description carries full burden but is inadequate. It mentions updating and a deletion method, but doesn't disclose critical behavioral traits like required permissions, whether updates are reversible, rate limits, or what happens to unspecified fields. The deletion note is vague and doesn't explain if it's a standard feature or workaround.

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 concise with two clauses, but the second clause about deletion is poorly integrated and confusing, reducing clarity. It's front-loaded with the main purpose but the additional note doesn't earn its place effectively, making the structure somewhat disjointed.

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 7 parameters, no annotations, and no output schema, the description is incomplete. It lacks details on behavior, error handling, return values, and how it differs from siblings. The deletion note adds confusion rather than completeness, failing to provide adequate context for safe and 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 description coverage is 100%, so the schema fully documents all 7 parameters. The description adds no meaningful parameter semantics beyond what's in the schema, such as explaining interactions between fields or special cases. It mentions 'delete' or 'remove' for the title but doesn't tie this to the 'name' parameter clearly.

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?

The description clearly states the verb ('Update') and resource ('existing issue in a project'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'create-issue' or 'get-issue' beyond the update action, and the second part about deleting with 'delete' or 'remove' is confusing rather than clarifying.

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 'create-issue' or 'get-issue'. It mentions a deletion method but doesn't clarify if this is the primary deletion mechanism or when to use it over other tools, offering minimal usage context.

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/kelvin6365/plane-mcp-server'

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