Skip to main content
Glama
Sign In
GitLab MCP Server

GitLab MCP Server

by ttpears
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Broadcast Messages

list_broadcast_messages
Read-onlyIdempotent

Retrieve all instance-wide broadcast messages from GitLab for monitoring or auditing announcements. Read-only operation returns paginated results.

Instructions

List all GitLab broadcast messages (instance-wide announcements). Read-only.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (1-based)
perPageNoResults per page
userCredentialsNoYour GitLab credentials (optional — falls back to the configured env token if not provided)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv4.0.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / page / maximum
      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

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and the description's "Read-only" merely restates them. It adds the useful scope note that results are instance-wide, but omits permission requirements, pagination behavior beyond the schema defaults, and whether the list is ordered — all relevant for a paginated admin-level feed.

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?

Two short sentences, scope stated first, zero padding. Nothing could be removed without losing information.

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?

For a zero-required-param list tool with fully documented schema and safety annotations, the definition covers what the resource is and its read-only nature. The one meaningful gap is the admin/credential requirement, which the userCredentials parameter hints at but the description never confirms.

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% and every parameter (page, perPage, userCredentials) is documented in the schema with defaults and bounds, so the description needs to add nothing and adds nothing. Baseline 3 applies.

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?

Clear verb+resource ("List all GitLab broadcast messages") with a parenthetical that explains the domain concept ("instance-wide announcements"). This distinguishes it from the singular get_broadcast_message and the create/update/delete siblings by implication, though it never names those siblings explicitly.

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?

Usage is only implied: you call it to enumerate broadcast messages. There is no statement of when to prefer get_broadcast_message (single record) over this list, and no note that broadcast messages are typically admin-scoped in GitLab, which materially affects whether an agent should attempt the call.

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