get-faceting
Retrieve faceting configuration for a Meilisearch index to understand how search results are categorized and filtered.
Instructions
Get the faceting setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/settings-tools.ts:155-163 (handler)Handler function that fetches the faceting settings from the Meilisearch API for the specified index UID using the /faceting endpoint.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:153-154 (schema)Input schema for the get-faceting tool, requiring an indexUid string.indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:135-139 (registration)Configuration object defining the get-faceting tool name, endpoint, and description within the specificSettingsTools array.{ name: "get-faceting", endpoint: "faceting", description: "Get the faceting setting", },
- src/tools/settings-tools.ts:147-166 (registration)The forEach loop that registers all specific get-settings tools, including get-faceting, by calling server.tool with the handler and schema.// 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/index.ts:67-67 (registration)Top-level registration call that invokes registerSettingsTools on the MCP server instance, thereby registering the get-faceting tool.registerSettingsTools(server);