list-messaging-services
Retrieve a list of messaging services (e.g., Kafka) with customizable fields, pagination, and filters for deleted or non-deleted entries.
Instructions
List messaging services (Kafka, etc.)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Comma-separated fields to include | |
| limit | No | ||
| before | No | ||
| after | No | ||
| include | No | non-deleted |
Implementation Reference
- src/tools/services.ts:96-98 (handler)The actual handler function that executes the list-messaging-services tool logic. Makes a GET request to /services/messagingServices with the provided params.
export async function listMessagingServices(params: z.infer<typeof listMessagingServicesSchema>) { return omClient.get("/services/messagingServices", params); } - src/tools/services.ts:5-11 (schema)The schema definition (listParams) used by listMessagingServicesSchema. Defines fields, limit, before, after, and include query parameters.
const listParams = z.object({ fields: z.string().optional().describe("Comma-separated fields to include"), limit: z.coerce.number().optional().default(10), before: z.string().optional(), after: z.string().optional(), include: z.enum(["non-deleted", "deleted", "all"]).optional().default("non-deleted"), }); - src/index.ts:225-225 (registration)Where the tool 'list-messaging-services' is registered with the MCP server using the tool() function, providing its description, schema shape, and wrapped handler.
tool("list-messaging-services", "List messaging services (Kafka, etc.)", listMessagingServicesSchema.shape, wrapToolHandler(listMessagingServices));