get-filterable-attributes
Retrieve the filterable attributes configuration for a Meilisearch index to understand which fields can be used for filtering search results.
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)The handler function that implements the logic for the "get-filterable-attributes" tool. It makes an API call to retrieve the filterable attributes setting from Meilisearch for the given indexUid, using the endpoint "filterable-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 "get-filterable-attributes" tool, defining the required indexUid parameter.
{ indexUid: z.string().describe("Unique identifier of the index"), }, - src/tools/settings-tools.ts:100-104 (registration)Configuration object in the specificSettingsTools array used to register the "get-filterable-attributes" tool.
{ name: "get-filterable-attributes", endpoint: "filterable-attributes", description: "Get the filterable attributes setting", }, - src/tools/settings-tools.ts:147-166 (registration)The forEach loop that dynamically registers the "get-filterable-attributes" tool (and other specific settings getters) on the MCP server using server.tool.
// 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); } } ); });