Skip to main content
Glama
zereight

gitlab mcp

by zereight
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

create_draft_note

Create a draft note for a GitLab merge request to save review comments before publishing. Supports inline diff positions, multiline comments, and discussion replies.

Instructions

Create a draft note for a merge request. Use this for a new resource or action; choose the corresponding update or edit tool when the resource already exists. It changes remote GitLab state and requires the necessary project or group permission; GitLab returns validation, conflict, permission, or rate-limit errors instead of silently applying an invalid request. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesThe content of the draft note
jmespathNoOptional JMESPath expression filtering the JSON result before return.
positionNoPosition when creating a diff note
project_idYesProject ID or complete URL-encoded path to project
merge_request_iidYesThe IID of a merge request
resolve_discussionNoWhether to resolve the discussion when publishing
in_reply_to_discussion_idNoThe ID of a discussion the draft note replies to

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.66
    • addedInput schema / properties / jmespath
      Added value: +{
+  "description": "Optional JMESPath expression filtering the JSON result before return.",
+  "type": "string"
+}
  2. Changed1 schema field changedv2.1.62
    • changedInput schema / required
      Previous value: -[
-  "body",
-  "project_id",
-  "merge_request_iid"
-]New value: +[
+  "project_id",
+  "merge_request_iid",
+  "body"
+]
  3. Addedv2.1.18
  4. Removedv2.1.14
  5. Addedv2.1.11
  6. Removedv2.1.10
  7. Changed9 schema fields changedv2.1.9
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / in_reply_to_discussion_id
      Added value: +{
+  "description": "The ID of a discussion the draft note replies to",
+  "type": "string"
+}
    • removedInput schema / properties / position / additionalProperties
      Removed value: -false
    • changedInput schema / properties / position / properties / height / type
      Previous value: -"number"New value: +[
+  "number",
+  "null"
+]
    • changedInput schema / properties / position / properties / line_range / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "description": "Line range for multiline comments on GitLab merge request diffs. VALIDATION RULES: 1) line_code is critical for GitLab API success, 2) start/end must have consistent types, 3) line numbers must form valid range, 4) get line_code from GitLab diff API, never generate manually.",
-    "properties": {
-      "end": {
-        "additionalProperties": false,
-        "description": "End line position for multiline comment range. MUST specify either old_line OR new_line (or both for context), never neither. Range must be valid (end >= start).",
-        "properties": {
-          "line_code": {
-            "description": "CRITICAL: Line identifier in format '{file_path_sha1_hash}_{old_line_number}_{new_line_number}'. USUALLY REQUIRED for GitLab diff comments despite being optional in schema. Example: 'a1b2c3d4e5f6_12_17'. Must be from same file as start.line_code.",
-            "type": [
-              "string",
-              "null"
-            ]
-          },
-          "new_line": {
-            "description": "Line number in modified file (after changes). REQUIRED when type='new', NULL when type='old' (for purely deleted lines), can be present for context lines. MUST be >= start.new_line if both specified.",
-            "type": [
-              "number",
-              "null"
-            ]
-          },
-          "old_line": {
-            "description": "Line number in original file (before changes). REQUIRED when type='old', NULL when type='new' (for purely added lines), can be present for context lines. MUST be >= start.old_line if both specified.",
-            "type": [
-              "number",
-              "null"
-            ]
-          },
-          "type": {
-            "anyOf": [
-              {
-                "enum": [
-                  "new",
-                  "old",
-                  "expanded",
-                  "logic",
-                  "style"
-                ],
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Line type: 'old' = deleted/original line, 'new' = added/modified line, null = unchanged context. SHOULD MATCH start.type for consistent ranges (don't mix old/new types)."
-          }
-        },
-        "type": "object"
-      },
-      "start": {
-        "additionalProperties": false,
-        "description": "Start line position for multiline comment range. MUST specify either old_line OR new_line (or both for context), never neither.",
-        "properties": {
-          "line_code": {
-            "description": "CRITICAL: Line identifier in format '{file_path_sha1_hash}_{old_line_number}_{new_line_number}'. USUALLY REQUIRED for GitLab diff comments despite being optional in schema. Example: 'a1b2c3d4e5f6_10_15'. Get this from GitLab diff API response, never fabricate.",
-            "type": [
-              "string",
-              "null"
-            ]
-          },
-          "new_line": {
-            "description": "Line number in modified file (after changes). REQUIRED when type='new', NULL when type='old' (for purely deleted lines), can be present for context lines.",
-            "type": [
-              "number",
-              "null"
-            ]
-          },
-          "old_line": {
-            "description": "Line number in original file (before changes). REQUIRED when type='old', NULL when type='new' (for purely added lines), can be present for context lines.",
-            "type": [
-              "number",
-              "null"
-            ]
-          },
-          "type": {
-            "anyOf": [
-              {
-                "enum": [
-                  "new",
-                  "old",
-                  "expanded",
-                  "logic",
-                  "style"
-                ],
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Line type: 'old' = deleted/original line, 'new' = added/modified line, null = unchanged context. MUST match the line_code format and old_line/new_line values."
-          }
-        },
-        "type": "object"
-      }
-    },
-    "required": [
-      "start",
-      "end"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "description": "Line range for multiline comments on GitLab merge request diffs. VALIDATION RULES: 1) line_code is critical for GitLab API success, 2) start/end must have consistent types, 3) line numbers must form valid range, 4) get line_code from GitLab diff API, never generate manually.",
+    "properties": {
+      "end": {
+        "description": "End line position for multiline comment range. MUST specify either old_line OR new_line (or both for context), never neither. Range must be valid (end >= start).",
+        "properties": {
+          "line_code": {
+            "description": "CRITICAL: Line identifier in format '{file_path_sha1_hash}_{old_line_number}_{new_line_number}'. USUALLY REQUIRED for GitLab diff comments despite being optional in schema. Example: 'a1b2c3d4e5f6_12_17'. Must be from same file as start.line_code.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "new_line": {
+            "description": "Line number in modified file (after changes). REQUIRED when type='new', NULL when type='old' (for purely deleted lines), can be present for context lines. MUST be >= start.new_line if both specified.",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "old_line": {
+            "description": "Line number in original file (before changes). REQUIRED when type='old', NULL when type='new' (for purely added lines), can be present for context lines. MUST be >= start.old_line if both specified.",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "type": {
+            "anyOf": [
+              {
+                "enum": [
+                  "new",
+                  "old",
+                  "expanded",
+                  "logic",
+                  "style"
+                ],
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Line type: 'old' = deleted/original line, 'new' = added/modified line, null = unchanged context. SHOULD MATCH start.type for consistent ranges (don't mix old/new types)."
+          }
+        },
+        "type": "object"
+      },
+      "start": {
+        "description": "Start line position for multiline comment range. MUST specify either old_line OR new_line (or both for context), never neither.",
+        "properties": {
+          "line_code": {
+            "description": "CRITICAL: Line identifier in format '{file_path_sha1_hash}_{old_line_number}_{new_line_number}'. USUALLY REQUIRED for GitLab diff comments despite being optional in schema. Example: 'a1b2c3d4e5f6_10_15'. Get this from GitLab diff API response, never fabricate.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "new_line": {
+            "description": "Line number in modified file (after changes). REQUIRED when type='new', NULL when type='old' (for purely deleted lines), can be present for context lines.",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "old_line": {
+            "description": "Line number in original file (before changes). REQUIRED when type='old', NULL when type='new' (for purely added lines), can be present for context lines.",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "type": {
+            "anyOf": [
+              {
+                "enum": [
+                  "new",
+                  "old",
+                  "expanded",
+                  "logic",
+                  "style"
+                ],
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Line type: 'old' = deleted/original line, 'new' = added/modified line, null = unchanged context. MUST match the line_code format and old_line/new_line values."
+          }
+        },
+        "type": "object"
+      }
+    },
+    "required": [
+      "start",
+      "end"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedInput schema / properties / position / properties / width / type
      Previous value: -"number"New value: +[
+  "number",
+  "null"
+]
    • changedInput schema / properties / position / properties / x / type
      Previous value: -"number"New value: +[
+  "number",
+  "null"
+]
    • changedInput schema / properties / position / properties / y / type
      Previous value: -"number"New value: +[
+  "number",
+  "null"
+]
    • changedInput schema / required
      Previous value: -[
-  "body"
-]New value: +[
+  "body",
+  "project_id",
+  "merge_request_iid"
+]
  8. First observedv1.0.0

TDQS

A4.1/5.0
Behavior4/5

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

With minimal annotations (only openWorldHint), the description carries the behavioral disclosure burden and does so well: it states that the tool 'changes remote GitLab state,' requires necessary project/group permission, and reports validation, conflict, permission, or rate-limit errors instead of silently applying invalid requests. This gives agents a clear picture of side effects and failure behavior, though it does not explicitly mention that draft notes remain unpublished until a separate publish action.

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

Conciseness4/5

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

The description is compact and front-loaded with the core purpose, followed by usage, side-effect, and identifier guidance. It is not bloated, though the final sentence contains somewhat boilerplate wording about pagination fields that does not apply to this tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a complex nested schema with 7 parameters and no output schema, the description adequately covers the essential context: what the tool does, when to use it, that it mutates remote state, that permissions are required, and how errors surface. It does not explain the draft-note lifecycle or how position/discussion parameters relate to GitLab semantics, but the schema itself provides detailed documentation for those fields.

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 parameters thoroughly and the baseline is 3. The description adds only generic guidance about providing numeric IDs or URL-encoded paths and using required identifiers; this mostly restates the schema's project_id description. The mention of 'group_id' and 'pagination fields' is not directly relevant to this tool's schema, so it adds little semantic value.

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 opens with a specific verb and resource: 'Create a draft note for a merge request.' It also distinguishes this creation tool from update/edit tools by stating to use it for new resources and to choose the corresponding update/edit tool when the resource already exists. This clearly separates it from siblings like update_draft_note and publish_draft_note.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance: use it for a new resource or action, and choose the corresponding update or edit tool when the resource already exists. However, it does not name the specific sibling tools or explain when to prefer this over related create tools like create_note or create_merge_request_note, so the exclusion guidance is generic rather than concrete.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools