listFeatureFlags
Retrieve all feature flags from a Bucketeer environment with filtering, pagination, and search options to manage feature rollouts.
Instructions
List all feature flags in the specified environment
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| environmentId | No | Environment ID (uses default if not provided) | |
| pageSize | No | Number of items per page (1-100) | |
| cursor | No | Pagination cursor for next page | |
| tags | No | Filter by tags | |
| orderBy | No | Field to order by | |
| orderDirection | No | Order direction | |
| searchKeyword | No | Search keyword for feature name or ID | |
| maintainer | No | Filter by maintainer email | |
| archived | No | Filter by archived status |
Implementation Reference
- src/tools/list-flags.ts:70-160 (handler)The handler function that executes the tool logic: validates input using Zod schema, initializes BucketeerClient, prepares the ListFeaturesRequest, calls the API, logs results, and returns structured content or error response.
handler: async (input: unknown) => { try { // Validate input const params = listFlagsSchema.parse(input); logger.debug("Listing feature flags", params); // Create API client const client = new BucketeerClient( config.bucketeerHost, config.bucketeerApiKey, ); // Prepare request const request: ListFeaturesRequest = { environmentId: getEnvironmentId(params.environmentId), pageSize: params.pageSize, cursor: params.cursor, tags: params.tags, orderBy: params.orderBy, orderDirection: params.orderDirection, searchKeyword: params.searchKeyword, maintainer: params.maintainer, archived: params.archived, }; // Make API call const response = await client.listFeatures(request); logger.info( `Successfully listed ${response.features.length} feature flags`, ); return { content: [ { type: "text", text: JSON.stringify( { success: true, features: response.features, cursor: response.cursor, totalCount: response.totalCount, }, null, 2, ), }, ], }; } catch (error) { logger.error("Failed to list feature flags", error); if (error instanceof z.ZodError) { return { content: [ { type: "text", text: JSON.stringify( { success: false, error: "Invalid input parameters", details: error.issues, }, null, 2, ), }, ], isError: true, }; } return { content: [ { type: "text", text: JSON.stringify( { success: false, error: error instanceof Error ? error.message : "Unknown error", }, null, 2, ), }, ], isError: true, }; } }, - src/tools/list-flags.ts:7-18 (schema)Zod input schema used for validating the parameters in the handler.
// Input schema for the list-flags tool export const listFlagsSchema = z.object({ environmentId: z.string().optional(), pageSize: z.number().min(1).max(100).optional().default(20), cursor: z.string().optional(), tags: z.array(z.string()).optional(), orderBy: z.enum(["CREATED_AT", "UPDATED_AT", "NAME"]).optional(), orderDirection: z.enum(["ASC", "DESC"]).optional(), searchKeyword: z.string().optional(), maintainer: z.string().optional(), archived: z.boolean().optional(), }); - src/tools/index.ts:7-13 (registration)Registration of the listFeatureFlags tool (as listFlagsTool) in the central tools array exported from the tools index.
export const tools = [ listFlagsTool, createFlagTool, getFlagTool, updateFlagTool, archiveFlagTool, ]; - src/tools/list-flags.ts:22-24 (registration)Tool object definition including the name 'listFeatureFlags', description, and reference to inputSchema and handler.
export const listFlagsTool = { name: "listFeatureFlags", description: "List all feature flags in the specified environment",