get-sortable-attributes
Retrieve sortable attributes for a Meilisearch index to enable ordered search results based on specific fields.
Instructions
Get the sortable 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)Handler function that fetches the sortable attributes setting from the Meilisearch API endpoint `/indexes/${indexUid}/settings/sortable-attributes` using the shared endpoint variable.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)Input schema using Zod, requiring 'indexUid' as a string.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:105-109 (registration)Configuration object in specificSettingsTools array that defines the tool name, endpoint, and description for registration.{ name: "get-sortable-attributes", endpoint: "sortable-attributes", description: "Get the sortable attributes setting", },
- src/tools/settings-tools.ts:147-166 (registration)forEach loop that dynamically registers the 'get-sortable-attributes' tool (and similar tools) by calling server.tool with the configuration, schema, and handler.// 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)Top-level invocation of registerSettingsTools on the MCP server, which registers the get-sortable-attributes tool among others.registerSettingsTools(server);