list_inbox_items
Retrieve and filter inbox items in the RAD Security MCP server by specifying search criteria such as severity, type, or keywords to manage and analyze security insights effectively.
Instructions
List inbox items with optional filtering by any field. Multiple filters can be combined eg. 'search:cve-2024-12345 and severity:high'
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters_query | No | Filter query string (e.g. full text search: 'search:<query>', severity: 'severity:low', type 'type:workflow_output' any other field). Multiple filters can be combined eg. 'search:cve-2024-12345 and severity:high' | |
| limit | No | Number of inbox items per page (default: 10) | |
| offset | No | Offset to retrieve (default: 0) |
Implementation Reference
- src/operations/inbox.ts:35-51 (handler)The main handler function that executes the logic to list inbox items using the RAD Security client API.export async function listInboxItems( client: RadSecurityClient, limit: number = 10, offset: number = 0, filters_query?: string, ): Promise<any> { const params: Record<string, any> = { limit, offset }; if (filters_query) { params.filters_query = filters_query; } return client.makeRequest( `/accounts/${client.getAccountId()}/data/inbox_items`, params ); }
- src/operations/inbox.ts:10-14 (schema)Zod schema defining the input parameters for the list_inbox_items tool.export const ListInboxItemsSchema = z.object({ limit: z.number().optional().default(10).describe("Number of inbox items per page (default: 10)"), offset: z.number().optional().default(0).describe("Offset to retrieve (default: 0)"), filters_query: z.string().optional().describe("Filter query string (e.g. full text search: 'search:<query>', severity: 'severity:low', type 'type:workflow_output' any other field). Multiple filters can be combined eg. 'search:cve-2024-12345 and severity:high'"), });
- src/index.ts:331-335 (registration)Tool registration in the list of available tools, including name, description, and input schema.{ name: "list_inbox_items", description: "List inbox items with optional filtering by any field. Multiple filters can be combined eg. 'search:cve-2024-12345 and severity:high'", inputSchema: zodToJsonSchema(inbox.ListInboxItemsSchema), },
- src/index.ts:749-759 (helper)Dispatch logic in the main tool handler that validates input and invokes the listInboxItems function.case "list_inbox_items": { const args = inbox.ListInboxItemsSchema.parse(request.params.arguments); const response = await inbox.listInboxItems( client, args.limit, args.offset, args.filters_query, ); return { content: [{ type: "text", text: JSON.stringify(response, null, 2) }], };