reset-searchable-attributes
Restore searchable attributes to default settings for a Meilisearch index, ensuring consistent search behavior by clearing custom configurations.
Instructions
Reset the searchable 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 executes the tool: performs a DELETE request to `/indexes/${indexUid}/settings/searchable-attributes` via apiClient to reset the setting.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 validation using Zod: requires 'indexUid' as string.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:254-258 (registration)Configuration object in resetSettingsTools array that defines this tool's name, endpoint, and description for dynamic registration.{ name: "reset-searchable-attributes", endpoint: "searchable-attributes", description: "Reset the searchable attributes setting to its default value", },
- src/tools/settings-tools.ts:312-330 (registration)Dynamic registration loop that calls server.tool for each reset tool using the configuration array, schema, and handler.resetSettingsTools.forEach(({ name, endpoint, description }) => { 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(server) which triggers the registration of all settings tools including 'reset-searchable-attributes'.registerSettingsTools(server);