update-filterable-attributes
Define filterable attributes for a Meilisearch index to refine search results by specifying JSON-based criteria, enhancing query precision and user experience.
Instructions
Update the filterable attributes setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| value | Yes | JSON value for the setting |
Implementation Reference
- src/tools/settings-tools.ts:180-184 (registration)Configuration object in updateSettingsTools array that defines the tool name 'update-filterable-attributes', the corresponding Meilisearch API endpoint 'filterable-attributes', and its description. This config is used in the subsequent forEach loop to register the tool.{ name: "update-filterable-attributes", endpoint: "filterable-attributes", description: "Update the filterable attributes setting", },
- src/tools/settings-tools.ts:232-235 (schema)Zod input schema used for the update-filterable-attributes tool (shared with other update tools): requires indexUid (string) and value (string representing JSON).{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), },
- src/tools/settings-tools.ts:236-248 (handler)Core handler logic for the update-filterable-attributes tool (shared with other update tools): parses the JSON value, performs a PUT request to the Meilisearch API at `/indexes/${indexUid}/settings/filterable-attributes` (via ${endpoint}), and returns the formatted response or error.async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/index.ts:67-67 (registration)Top-level call to registerSettingsTools(server), which in turn registers the 'update-filterable-attributes' tool via its configuration and handler.registerSettingsTools(server);