Skip to main content
Glama
Sign In
ttpears

GitLab MCP Server

by ttpears
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Update Broadcast Message

update_broadcast_message
Idempotent

Update an existing GitLab broadcast message by ID, including text, scheduling, colors, theme, target path, access levels, and dismissibility; administrator privileges required.

Instructions

Update an existing GitLab broadcast message. Requires administrator privileges.

Input Schema

NameRequiredDescriptionDefault
idYesBroadcast message ID
fontNoForeground (font) color in hex format
colorNoBackground color in hex format, e.g. "#E75E40"
themeNoTheme name (GitLab 16.9+), e.g. "indigo", "red"
ends_atNoISO 8601 timestamp when the message ends
messageNoMessage text to display
starts_atNoISO 8601 timestamp when the message starts
dismissableNoWhether users can dismiss the broadcast message
target_pathNoPath glob for pages where the message should appear
broadcast_typeNoBroadcast type: "banner" or "notification"
userCredentialsNoYour GitLab credentials (optional — falls back to the configured env token if not provided)
target_access_levelsNoAccess levels to target: 10=Guest, 20=Reporter, 30=Developer, 40=Maintainer, 50=Owner

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv4.0.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / ends_at / pattern
      Added value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    • addedInput schema / properties / id / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / id / minimum
      Added value: +-9007199254740991
    • addedInput schema / properties / starts_at / pattern
      Added value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    • addedInput schema / properties / target_access_levels / items / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / target_access_levels / items / minimum
      Added value: +-9007199254740991
    • changedInput schema / properties / userCredentials / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "accessToken": {
-        "minLength": 1,
-        "type": "string"
-      },
-      "gitlabUrl": {
-        "format": "uri",
-        "type": "string"
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "properties": {
+      "accessToken": {
+        "minLength": 1,
+        "type": "string"
+      },
+      "gitlabUrl": {
+        "format": "uri",
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
  2. Addedv1.15.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the mutation/safety profile is covered. The description adds the admin-privilege requirement, which is genuine auth context, but omits what happens to fields not supplied (merge vs. replace) — important for a 12-param update tool.

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?

Two short sentences, front-loaded with the action and followed by the permission constraint. No filler, though there is very little content to structure.

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

Completeness3/5

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

For a 12-parameter mutation with no output schema, the description covers identity and access requirements but not update semantics (which fields are optional, whether omitted fields are cleared) or any return information. Adequate to attempt the call correctly, but thin at the edges.

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 all 12 parameters including enums and access-level encoding are documented in the schema itself. The description adds no additional meaning beyond that, which is the expected baseline 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?

States a specific verb and resource ("Update an existing GitLab broadcast message"), which is unambiguous against siblings like create_broadcast_message or delete_broadcast_message. It doesn't explicitly name alternatives, but the operation class is clear from the verb.

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

Usage Guidelines3/5

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

"Requires administrator privileges" is a useful precondition that tells the agent when the call will fail. However, it says nothing about partial vs. full update semantics or when to prefer this over create/delete for a message, leaving usage largely implied by the tool name.

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