add-documents
Add documents to a Meilisearch index by providing a JSON array of documents and specifying the target index identifier. This tool enables document ingestion for search functionality.
Instructions
Add documents to a Meilisearch index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| indexUid | Yes | Unique identifier of the index | |
| documents | Yes | JSON array of documents to add | |
| primaryKey | No | Primary key for the documents |
Implementation Reference
- src/tools/document-tools.ts:124-151 (handler)Handler function for 'add-documents' tool: parses JSON documents string, validates array, sets optional primaryKey param, and POSTs to Meilisearch /indexes/{indexUid}/documents endpoint.
async ({ indexUid, documents, primaryKey }: AddDocumentsParams) => { try { // Parse the documents string to ensure it's valid JSON const parsedDocuments = JSON.parse(documents); // Ensure documents is an array if (!Array.isArray(parsedDocuments)) { return { isError: true, content: [{ type: 'text', text: 'Documents must be a JSON array' }], }; } const params: Record<string, string> = {}; if (primaryKey) { params.primaryKey = primaryKey; } const response = await apiClient.post(`/indexes/${indexUid}/documents`, parsedDocuments, { params, }); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } - src/tools/document-tools.ts:119-123 (schema)Zod input schema for 'add-documents' tool parameters.
{ indexUid: z.string().describe('Unique identifier of the index'), documents: z.string().describe('JSON array of documents to add'), primaryKey: z.string().optional().describe('Primary key for the documents'), }, - src/tools/document-tools.ts:28-32 (schema)TypeScript interface matching the handler parameters for 'add-documents'.
interface AddDocumentsParams { indexUid: string; documents: string; primaryKey?: string; } - src/tools/document-tools.ts:116-152 (registration)Direct MCP server.tool registration block for the 'add-documents' tool.
server.tool( 'add-documents', 'Add documents to a Meilisearch index', { indexUid: z.string().describe('Unique identifier of the index'), documents: z.string().describe('JSON array of documents to add'), primaryKey: z.string().optional().describe('Primary key for the documents'), }, async ({ indexUid, documents, primaryKey }: AddDocumentsParams) => { try { // Parse the documents string to ensure it's valid JSON const parsedDocuments = JSON.parse(documents); // Ensure documents is an array if (!Array.isArray(parsedDocuments)) { return { isError: true, content: [{ type: 'text', text: 'Documents must be a JSON array' }], }; } const params: Record<string, string> = {}; if (primaryKey) { params.primaryKey = primaryKey; } const response = await apiClient.post(`/indexes/${indexUid}/documents`, parsedDocuments, { params, }); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }], }; } catch (error) { return createErrorResponse(error); } } ); - src/index.ts:65-65 (registration)Top-level call to registerDocumentTools(server), which registers the 'add-documents' tool among others.
registerDocumentTools(server);