reset-filterable-attributes
Restore filterable attributes to default values for a Meilisearch index, clearing custom configurations to reset search filtering behavior.
Instructions
Reset the filterable attributes setting to its default value
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"indexUid": {
"description": "Unique identifier of the index",
"type": "string"
}
},
"required": [
"indexUid"
],
"type": "object"
}
Implementation Reference
- src/tools/settings-tools.ts:319-328 (handler)Handler function that performs a DELETE request to reset the filterable-attributes setting via the Meilisearch API for the given indexUid. Uses the endpoint from configuration and handles errors with createErrorResponse.async ({ indexUid }) => { try { const response = await apiClient.delete(`/indexes/${indexUid}/settings/${endpoint}`); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/settings-tools.ts:316-318 (schema)Input schema defining the required indexUid parameter as a string.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:264-268 (registration)Configuration object in the resetSettingsTools array that defines the specific tool name, endpoint, and description for registration.{ name: "reset-filterable-attributes", endpoint: "filterable-attributes", description: "Reset the filterable attributes setting to its default value", },
- src/tools/settings-tools.ts:313-329 (registration)The server.tool registration call within the forEach loop that registers the reset-filterable-attributes tool using the config and shared handler/schema.server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.delete(`/indexes/${indexUid}/settings/${endpoint}`); 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 on the MCP server instance, which includes registration of the reset-filterable-attributes tool.registerSettingsTools(server);