get-searchable-attributes
Retrieve the searchable attributes setting for a specific index in Meilisearch, enabling precise control over search functionality within your indexed data.
Instructions
Get the searchable attributes setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:155-164 (handler)The handler function for the "get-searchable-attributes" tool. It makes an API call to retrieve the searchable attributes setting for the specified Meilisearch index using the dynamic endpoint "searchable-attributes".async ({ indexUid }) => { try { const response = await apiClient.get(`/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:152-154 (schema)Input schema for the tool, defining the required 'indexUid' parameter using Zod.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:90-94 (registration)Configuration entry in the specificSettingsTools array that defines the name, endpoint, and description for the "get-searchable-attributes" tool, used in dynamic registration.{ name: "get-searchable-attributes", endpoint: "searchable-attributes", description: "Get the searchable attributes setting", },
- src/tools/settings-tools.ts:148-166 (registration)Dynamic registration loop that registers the "get-searchable-attributes" tool (and similar tools) by calling server.tool with the configuration from specificSettingsTools.specificSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), }, async ({ indexUid }) => { try { const response = await apiClient.get(`/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 registration call in the main server setup that invokes registerSettingsTools to register all settings tools, including "get-searchable-attributes".registerSettingsTools(server);