Delete Broadcast Message
delete_broadcast_messageDestructiveIdempotent
Delete a broadcast message from GitLab using its ID. Requires administrator privileges for access.
Instructions
Delete a GitLab broadcast message by ID. Requires administrator privileges.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Broadcast message ID | |
| userCredentials | No | Your GitLab credentials (optional — falls back to the configured env token if not provided) |
Implementation Reference
- src/tools.ts:1745-1763 (handler)The Tool definition and handler for 'delete_broadcast_message'. It takes an id, authenticates, calls client.deleteBroadcastMessage, and returns a success object.
const deleteBroadcastMessageTool: Tool = { name: 'delete_broadcast_message', title: 'Delete Broadcast Message', description: 'Delete a GitLab broadcast message by ID. Requires administrator privileges.', requiresAuth: true, requiresWrite: true, annotations: { readOnlyHint: false, destructiveHint: true, idempotentHint: true }, inputSchema: withUserAuth(z.object({ id: z.number().int().describe('Broadcast message ID'), })), handler: async (input, client, userConfig) => { const credentials = input.userCredentials ? validateUserConfig(input.userCredentials) : userConfig; if (!credentials) { throw new Error('User authentication is required for deleting broadcast messages.'); } await client.deleteBroadcastMessage(input.id, credentials); return { id: input.id, deleted: true }; }, }; - src/tools.ts:1752-1754 (schema)Input schema for delete_broadcast_message: requires an integer 'id' field.
inputSchema: withUserAuth(z.object({ id: z.number().int().describe('Broadcast message ID'), })), - src/tools.ts:2307-2317 (registration)deleteBroadcastMessageTool is registered in the writeTools array, which is exported and included in the main tools list.
export const writeTools: Tool[] = [ createIssueTool, createMergeRequestTool, createNoteTool, deleteNoteTool, updateNoteTool, managePipelineTool, createBroadcastMessageTool, updateBroadcastMessageTool, deleteBroadcastMessageTool, ]; - src/gitlab-client.ts:2699-2701 (helper)Helper/client method that performs a REST DELETE request to GitLab's /broadcast_messages/:id endpoint.
async deleteBroadcastMessage(id: number, userConfig?: UserConfig): Promise<any> { return this.restRequest('DELETE', `/broadcast_messages/${id}`, { userConfig, requiresWrite: true }); }