update-displayed-attributes
Modify which document attributes appear in search results for a Meilisearch index to control data visibility and improve user experience.
Instructions
Update the displayed attributes setting
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| value | Yes | JSON value for the setting |
Implementation Reference
- src/tools/settings-tools.ts:236-248 (handler)Handler function that parses the provided JSON value and sends a PUT request to update the displayed-attributes setting via the API.
async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } - src/tools/settings-tools.ts:232-235 (schema)Input schema definition using Zod: indexUid (string) and value (string representing JSON).
{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, - src/tools/settings-tools.ts:175-179 (registration)Configuration object in updateSettingsTools array that defines the tool's name, endpoint, and description for dynamic registration.
{ name: "update-displayed-attributes", endpoint: "displayed-attributes", description: "Update the displayed attributes setting", }, - src/tools/settings-tools.ts:228-250 (registration)The forEach loop that dynamically registers the update-displayed-attributes tool (and others) on the MCP server using server.tool.
updateSettingsTools.forEach(({ name, endpoint, description }) => { server.tool( name, description, { indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), }, async ({ indexUid, value }) => { try { // Parse the value string to ensure it's valid JSON const parsedValue = JSON.parse(value); const response = await apiClient.put(`/indexes/${indexUid}/settings/${endpoint}`, parsedValue); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } ); });