Skip to main content
Glama

create_note

Add comments to GitLab issues or merge requests to document discussions, provide feedback, or track progress.

Instructions

Create a new note (comment) to an issue or merge request

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idNoProject ID or namespace/project_path
noteable_typeYesType of noteable (issue or merge_request)
noteable_iidNoIID of the issue or merge request
bodyYesNote content
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. It states it 'creates' something, implying a write/mutation operation, but doesn't disclose behavioral traits like authentication requirements, rate limits, side effects, or what happens on failure. For a creation tool with zero annotation coverage, this is a significant gap in transparency.

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 that directly states the tool's purpose with zero waste. It's appropriately sized and front-loaded, making it easy for an agent 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?

Given this is a creation/mutation tool with no annotations and no output schema, the description is incomplete. It doesn't cover behavioral aspects (e.g., permissions, error handling), usage context, or output expectations, leaving significant gaps for an agent to operate effectively.

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 four parameters thoroughly. The description adds no additional meaning beyond what the schema provides (e.g., it doesn't explain relationships between parameters like how 'project_id' relates to 'noteable_iid'). 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 action ('Create a new note') and the target resource ('to an issue or merge request'), which is specific and unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'create_issue_note' or 'create_merge_request_note', which appear to be more specific versions of the same functionality.

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 'create_merge_request_note' from the sibling list. It also doesn't mention prerequisites, constraints, or typical use cases, leaving the agent to infer usage from parameter names alone.

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

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