gitlab-api

Create commit comment

gitlab_create_commit_comment

Creates a comment on a GitLab commit so you can discuss or annotate specific changes.

Instructions

Create a comment on a commit.

Args: **kwargs: Additional parameters for the request.

Returns: Response: A wrapper containing the original response and a Comment model.

Raises: ParameterError: If invalid parameters are provided.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "gitlab_create_commit_comment"
  }
}

Input Schema

Name	Required	Description	Default
`all`	No
`ref`	No
`data`	No
`line`	No
`name`	No
`note`	No
`page`	No
`path`	No
`force`	No
`since`	No
`state`	No
`stats`	No
`until`	No
`branch`	No
`actions`	No
`context`	No
`dry_run`	No
`message`	No
`coverage`	No
`per_page`	No
`ref_name`	No
`user_ids`	No
`group_ids`	No
`line_type`	No
`max_pages`	No
`rule_type`	No
`start_sha`	No
`project_id`	No
`target_url`	No
`with_stats`	No
`author_name`	No
`commit_hash`	No
`description`	No
`pipeline_id`	No
`report_type`	No
`author_email`	No
`start_branch`	No
`start_project`	No
`protected_branch_ids`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv27.3.20Nov 7, 2026

removedInput schema / properties / api_parameters

Removed value: -{
-  "anyOf": [
-    {
-      "additionalProperties": true,
-      "type": "object"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null
-}

removedInput schema / properties / author_email / anyOf

Removed value: -[
-  {
-    "format": "email",
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / author_email / title
```
Added value: +"Author Email"
```
changedInput schema / properties / page / default
```
Previous value: -1New value: +null
```
changedInput schema / properties / per_page / default
```
Previous value: -100New value: +null
```
addedInput schema / properties / project_id / default
```
Added value: +null
```

removedInput schema / properties / target_url / anyOf

Removed value: -[
-  {
-    "format": "uri",
-    "maxLength": 2083,
-    "minLength": 1,
-    "type": "string"
-  },
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / target_url / title
```
Added value: +"Target Url"
```
removedInput schema / required
```
Removed value: -[
-  "project_id"
-]
```

First observedv27.3.13Oct 25, 2026

TDQS

C2.6/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds genuine value by disclosing the return shape ('Response: wrapper containing the original response and a Comment model') even though no output schema exists, and by naming ParameterError as the failure mode. It says nothing, however, about what makes a comment valid or what permissions are needed.

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 lead sentence is well front-loaded and appropriately short. However, the Args/Returns/Raises block is largely auto-generated boilerplate, and the Args entry ('Additional parameters for the request') consumes space without conveying information.

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

Completeness1/5

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

This is a mutation tool with 39 undocumented parameters, zero schema description coverage, and no output schema. The description never identifies which parameters are needed to create a comment (commit reference, body, line/path for inline comments), which is the central thing an agent must know. Naming the return type and error class does not compensate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 39 parameters with 0% description coverage, and the description contributes nothing except '**kwargs: Additional parameters for the request,' which is a tautology that restates the schema rather than explaining it. The agent is left to guess that commit_hash, note, project_id, and line/path matter, and to guess at the meaning of unrelated fields like coverage, rule_type, or start_project.

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 first sentence states a specific verb and resource: 'Create a comment on a commit.' An agent can tell this writes a commit comment rather than a general note or an issue note. It does not distinguish itself from nearby siblings such as gitlab_create_note or gitlab_get_commit_comments, so it stops short of a 5.

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?

There is no guidance on when to use this versus gitlab_create_note, gitlab_get_commit_comments, or any other comment-related sibling. No prerequisites, no exclusions, no context about what a commit comment is used for.

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

Deploy Server