Skip to main content
Glama
harshmaur

GitLab MCP Server

by harshmaur

update_issue_note

Modify an existing note in a GitLab issue thread to update information, correct errors, or add clarifications.

Instructions

Modify an existing issue thread note

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesProject ID or complete URL-encoded path to project
issue_iidYesThe IID of an issue
discussion_idYesThe ID of a thread
note_idYesThe ID of a thread note
bodyYesThe content of the note or reply

Implementation Reference

  • Zod schema defining the input parameters for the 'update_issue_note' tool, including project_id, issue_iid, discussion_id, note_id, and body.
    export const UpdateIssueNoteSchema = ProjectParamsSchema.extend({
      issue_iid: z.number().describe("The IID of an issue"),
      discussion_id: z.string().describe("The ID of a thread"),
      note_id: z.number().describe("The ID of a thread note"),
      body: z.string().describe("The content of the note or reply"),
    });
  • Type export for the UpdateIssueNoteSchema used by the update_issue_note tool.
    export type UpdateIssueNoteOptions = z.infer<typeof UpdateIssueNoteSchema>;
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Modify' implies a mutation, but the description doesn't specify permissions required, whether changes are reversible, rate limits, or what happens on success/failure. This leaves significant gaps for a tool that alters data.

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 with zero waste. It's front-loaded with the core action and resource, making it easy to parse quickly.

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?

For a mutation tool with no annotations and no output schema, the description is incomplete. It lacks critical context like behavioral traits (e.g., error handling, side effects), usage guidelines relative to siblings, and output expectations, leaving the agent under-informed.

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 already documents all 5 parameters. The description adds no additional meaning about parameters beyond what the schema provides, such as explaining relationships between 'discussion_id' and 'note_id'. 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.

Purpose4/5

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

The description clearly states the verb ('Modify') and resource ('an existing issue thread note'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'update_issue' or 'create_issue_note' beyond the basic resource specification.

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_note' or 'update_issue'. It lacks context about prerequisites, such as needing an existing note to modify, or exclusions for when this tool is inappropriate.

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/harshmaur/gitlab-mcp'

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