update-displayed-attributes
Configure which document fields appear in search results by updating displayed attributes for a Meilisearch index.
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 JSON value and performs a PUT request to the Meilisearch API endpoint `/indexes/{indexUid}/settings/displayed-attributes` to update the displayed attributes.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 using Zod for the tool parameters: indexUid (string) and value (JSON string for the new displayed attributes).{ indexUid: z.string().describe("Unique identifier of the index"), value: z.string().describe("JSON value for the setting"), },
- src/tools/settings-tools.ts:228-250 (registration)Registration of the update-displayed-attributes tool via the forEach loop over updateSettingsTools, using server.tool() with name, description, schema, and handler.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); } } ); });
- src/tools/settings-tools.ts:175-179 (registration)Configuration entry in updateSettingsTools array that defines the tool's name, endpoint ('displayed-attributes'), and description for registration.{ name: "update-displayed-attributes", endpoint: "displayed-attributes", description: "Update the displayed attributes setting", },
- src/index.ts:67-67 (registration)Top-level invocation of registerSettingsTools(server), which registers all settings tools including 'update-displayed-attributes'.registerSettingsTools(server);