update-displayed-attributes
Configure which fields appear in search results by updating displayed attributes for a Meilisearch index.
Instructions
Update the displayed attributes setting
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| value | Yes | JSON value for the setting |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"indexUid": {
"description": "Unique identifier of the index",
"type": "string"
},
"value": {
"description": "JSON value for the setting",
"type": "string"
}
},
"required": [
"indexUid",
"value"
],
"type": "object"
}
Implementation Reference
- src/tools/settings-tools.ts:236-248 (handler)Shared handler function that executes the tool: parses the JSON value and performs a PUT request to `/indexes/${indexUid}/settings/displayed-attributes` using the endpoint from configuration.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)Zod input schema defining parameters: indexUid (string) and value (JSON string for the setting).{ 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)Tool configuration object in updateSettingsTools array, specifying 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:227-250 (registration)Dynamic forEach loop that registers the update-displayed-attributes tool (and siblings) by calling server.tool with the configuration, shared schema, and handler.// Create an update tool for each specific setting 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/index.ts:67-67 (registration)Top-level registration call in main server setup that invokes registerSettingsTools to add all settings tools including update-displayed-attributes.registerSettingsTools(server);