get-displayed-attributes
Retrieve displayed attributes configuration for a Meilisearch index to understand which fields are returned in search results.
Instructions
Get the displayed attributes 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:155-164 (handler)The handler function that executes the tool logic: fetches the 'displayed-attributes' setting from Meilisearch API for the given indexUid and returns the JSON response.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:152-154 (schema)The input schema for the tool, requiring an indexUid string.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:95-99 (registration)Configuration object in the specificSettingsTools array that defines the tool name, endpoint, and description, used by the forEach loop to register the tool.{ name: "get-displayed-attributes", endpoint: "displayed-attributes", description: "Get the displayed attributes setting", },
- src/tools/settings-tools.ts:148-166 (registration)The forEach loop that dynamically registers the 'get-displayed-attributes' tool (and others) on the MCP server using the configuration from the array.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 call to registerSettingsTools(server), which in turn registers the get-displayed-attributes tool.registerSettingsTools(server);