get-filterable-attributes
Retrieve filterable attributes configuration for a Meilisearch index to enable structured search filtering and refine query results.
Instructions
Get the filterable attributes setting
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:155-164 (handler)The handler function for the 'get-filterable-attributes' tool. It makes a GET request to the Meilisearch API at `/indexes/${indexUid}/settings/filterable-attributes` (endpoint set to 'filterable-attributes') and returns the JSON response or an 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)The Zod input schema for the tool, validating 'indexUid' as a required string with description.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:100-104 (registration)Configuration object in the specificSettingsTools array that defines the name, endpoint, and description for the 'get-filterable-attributes' tool, used in the registration loop.{ 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 registers the 'get-filterable-attributes' tool (and other specific settings tools) by calling server.tool with the configuration from the array.// 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); } } ); });