get-filterable-attributes
Retrieve the filterable attributes setting for a Meilisearch index to understand which fields can be used to refine search results through filtering.
Instructions
Get the filterable 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)Shared handler function for get-filterable-attributes tool that makes an API GET request to retrieve filterable attributes from the specified Meilisearch index and returns the JSON response or error.
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 get-filterable-attributes tool, requiring an indexUid string parameter.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:147-166 (registration)Dynamic registration of the get-filterable-attributes tool (and similar specific settings getters) via server.tool call within a forEach loop over configurations.
// Create a tool for each specific setting 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/tools/settings-tools.ts:100-104 (registration)Configuration object in specificSettingsTools array that defines the name, endpoint, and description used to register the get-filterable-attributes tool.
{ name: "get-filterable-attributes", endpoint: "filterable-attributes", description: "Get the filterable attributes setting", }, - src/index.ts:67-67 (registration)Top-level call to registerSettingsTools(server) which triggers the registration of all settings tools including get-filterable-attributes.
registerSettingsTools(server);