get-index
Retrieve detailed information about a specific Meilisearch index by providing its unique identifier, enabling efficient index management and oversight.
Instructions
Get information about a specific Meilisearch index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index |
Implementation Reference
- src/tools/index-tools.ts:79-88 (handler)The handler function that executes the 'get-index' tool logic: fetches index information from the Meilisearch API using apiClient and returns a JSON-formatted response or handles errors with createErrorResponse.async ({ indexUid }: GetIndexParams) => { try { const response = await apiClient.get(`/indexes/${indexUid}`); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } }
- src/tools/index-tools.ts:77-78 (schema)Zod input schema for the 'get-index' tool, defining the required 'indexUid' parameter.indexUid: z.string().describe('Unique identifier of the index'), },
- src/tools/index-tools.ts:74-89 (registration)Direct registration of the 'get-index' tool using server.tool(), including name, description, schema, and handler.'get-index', 'Get information about a specific Meilisearch index', { indexUid: z.string().describe('Unique identifier of the index'), }, async ({ indexUid }: GetIndexParams) => { try { const response = await apiClient.get(`/indexes/${indexUid}`); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } );
- src/index.ts:64-64 (registration)Top-level call to registerIndexTools which includes the 'get-index' tool registration on the main MCP server instance.registerIndexTools(server);
- src/tools/index-tools.ts:19-21 (schema)TypeScript interface defining the input parameters for the 'get-index' handler.interface GetIndexParams { indexUid: string; }