Skip to main content
Glama

create_note

Create a top-level comment on a GitLab issue or merge request. Use this action to add a direct note when no threaded reply is required, returning the created note or error.

Instructions

Create a new note (comment) to an issue or merge request. Use this for a top-level comment on an issue or merge request when no typed discussion operation is needed; use create_merge_request_thread or create_issue_note for threaded replies. The operation creates remote discussion content, requires note permission, and returns the created note or a target/permission/validation error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesNote content
jmespathNoOptional JMESPath expression filtering the JSON result before return.
project_idYesProject ID or namespace/project_path
noteable_iidYesIID of the issue or merge request
noteable_typeYesType of noteable (issue or merge_request)

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: -[
      -  "noteable_type",
      -  "body",
      -  "project_id",
      -  "noteable_iid"
      -]New value: +[
      +  "project_id",
      +  "noteable_type",
      +  "noteable_iid",
      +  "body"
      +]
  3. Addedv2.1.18
  4. Removedv2.1.14
  5. Addedv2.1.11
  6. Removedv2.1.10
  7. Changed2 schema fields changedv2.1.9
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / required
      Previous value: -[
      -  "noteable_type",
      -  "body"
      -]New value: +[
      +  "noteable_type",
      +  "body",
      +  "project_id",
      +  "noteable_iid"
      +]
  8. First observedv1.0.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only provide openWorldHint, so the description carries the burden of behavioral disclosure. It adds useful context: the operation creates remote discussion content, requires note permission, and returns the created note or a target/permission/validation error. This goes beyond the minimal 'creates a note' statement.

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?

Three sentences with no waste. The opening states the operation and resource, the second sentence routes to alternatives, and the third covers remote effect, permissions, and return value. Every sentence earns its place.

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

Completeness5/5

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

For a creation tool with full schema coverage and no output schema, the description gives the key operational details: top-level scope, alternatives, remote side effect, permission requirement, and possible return/error outcomes. Nothing essential is missing for correct invocation.

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 five parameters including the enum for noteable_type. The description adds no per-parameter syntax or format detail but reinforces the overall purpose; baseline 3 applies.

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?

States a specific verb ('Create') and resource ('a new note (comment) to an issue or merge request'), and distinguishes itself from sibling tools by explicitly framing itself as the top-level comment operation. The description clarifies it is not for threaded replies, so an agent can tell it apart from create_merge_request_thread and create_issue_note.

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

Usage Guidelines5/5

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

Provides explicit when-to-use guidance: 'Use this for a top-level comment on an issue or merge request when no typed discussion operation is needed'. It also names alternatives for threaded replies, giving clear routing and exclusions.

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