List Broadcast Messages
list_broadcast_messagesRead-onlyIdempotent
Retrieve all GitLab broadcast messages to view instance-wide announcements. Supports pagination and optional credentials.
Instructions
List all GitLab broadcast messages (instance-wide announcements). Read-only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-based) | |
| perPage | No | Results per page | |
| userCredentials | No | Your GitLab credentials (optional — falls back to the configured env token if not provided) |
Implementation Reference
- src/tools.ts:1664-1679 (handler)The Tool definition for 'list_broadcast_messages' — it accepts pagination params (page, perPage) and delegates to client.listBroadcastMessages.
const listBroadcastMessagesTool: Tool = { name: 'list_broadcast_messages', title: 'List Broadcast Messages', description: 'List all GitLab broadcast messages (instance-wide announcements). Read-only.', requiresAuth: false, requiresWrite: false, annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true }, inputSchema: withUserAuth(z.object({ page: z.number().int().min(1).default(1).describe('Page number (1-based)'), perPage: z.number().int().min(1).max(100).default(20).describe('Results per page'), })), handler: async (input, client, userConfig) => { const credentials = input.userCredentials ? validateUserConfig(input.userCredentials) : userConfig; return client.listBroadcastMessages(input.page, input.perPage, credentials); }, }; - src/tools.ts:1671-1674 (schema)Input schema for list_broadcast_messages: page (default 1) and perPage (default 20, max 100), wrapped with optional user auth.
inputSchema: withUserAuth(z.object({ page: z.number().int().min(1).default(1).describe('Page number (1-based)'), perPage: z.number().int().min(1).max(100).default(20).describe('Results per page'), })), - src/tools.ts:2290-2291 (registration)Tool registered in the readOnlyTools array, making it available as a read-only tool.
listBroadcastMessagesTool, getBroadcastMessageTool, - src/gitlab-client.ts:2658-2663 (helper)The client method that performs the REST API call to GitLab's GET /api/v4/broadcast_messages, using the restRequest helper.
async listBroadcastMessages(page = 1, perPage = 20, userConfig?: UserConfig): Promise<any> { return this.restRequest('GET', '/broadcast_messages', { query: { page, per_page: Math.min(perPage, this.config.maxPageSize) }, userConfig, }); }