get-faceting
Retrieve faceting configuration settings for a Meilisearch index to manage search result categorization and filtering options.
Instructions
Get the faceting 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:154-163 (handler)The handler function for the 'get-faceting' tool. It retrieves the faceting settings from the Meilisearch API using the endpoint `/indexes/${indexUid}/settings/faceting` (via ${endpoint}) and returns the JSON response as text content.}, 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:151-153 (schema)Shared input schema for specific settings getter tools including 'get-faceting': requires 'indexUid' string parameter.description, { indexUid: z.string().describe("Unique identifier of the index"),
- src/tools/settings-tools.ts:135-139 (registration)Configuration object in specificSettingsTools array that defines the 'get-faceting' tool's name, Meilisearch endpoint ('faceting'), and description for dynamic registration.{ name: "get-faceting", endpoint: "faceting", description: "Get the faceting setting", },
- src/tools/settings-tools.ts:147-166 (registration)Dynamic registration code that creates and registers the 'get-faceting' tool (and other specific settings getters) on the MCP server using the configuration 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); } } ); });
- src/index.ts:67-67 (registration)Invocation of registerSettingsTools on the main MCP server instance, which registers all settings tools including 'get-faceting'.registerSettingsTools(server);