get-searchable-attributes
Retrieve the searchable attributes configuration for a Meilisearch index to understand which fields are indexed for queries.
Instructions
Get the searchable 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 executes the tool: fetches searchable attributes from Meilisearch API endpoint `/indexes/${indexUid}/settings/searchable-attributes` using apiClient, returns JSON or error 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)Input schema validation using Zod: requires 'indexUid' as string.{ indexUid: z.string().describe("Unique identifier of the index"), },
- src/tools/settings-tools.ts:91-94 (registration)Tool configuration object specifying name, endpoint, and description for dynamic registration.name: "get-searchable-attributes", endpoint: "searchable-attributes", description: "Get the searchable attributes setting", },
- src/tools/settings-tools.ts:147-166 (registration)Dynamic registration loop that calls server.tool for each specific settings tool, including get-searchable-attributes.// 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 registration of all settings tools by calling registerSettingsTools on the MCP server instance.registerSettingsTools(server);