Meilisearch MCP Server

🚀 Meilisearch MCP Server

🚀 Quick Start

This guide will help you quickly get started with the Meilisearch MCP Server.

✨ Features

• Search Function: Supports basic and advanced search.
• Index Management: Allows creating and deleting indexes.
• Advanced Features: Includes asynchronous tasks and logging.

📦 Installation

Installation Steps

1. Clone the repository

   git clone https://github.com/your-username/meilisearch-mcp-server.git
   cd meilisearch-mcp-server
   

2. Install dependencies

   npm install
   

3. Start the server

   npm start
   

💻 Usage Examples

Quick Start

Configure the following in package.json:

{
  "scripts": {
    "start": "mcp-server"
  }
}

Then run:

npm run start

Configuration File

Create or modify the config.json file:

{
  "host": "localhost",
  "port": 3000,
  "api_key": "your_api_key"
}

Search Function

Basic Usage

const result = await mcp.search({
  index: 'your_index',
  query: 'search_term'
});

Advanced Usage

const result = await mcp.advancedSearch({
  index: 'your_index',
  query: {
    bool: {
      must: [
        { term: { field: 'status', value: 'active' } }
      ]
    }
  }
});

Index Management

Basic Usage

await mcp.createIndex('new_index');

Advanced Usage

await mcp.deleteIndex('existing_index');

Asynchronous Tasks

const taskId = await mcp.startTask('your_task_description');
await mcp.waitForTask(taskId);

Logging

Enable Logging

mcp.enableLogging(true);

View Logs

const logs = await mcp.fetchLogs();

📚 Documentation

Integration Steps

1. Install the dependency:

   npm install meilisearch-mcp-server
   

2. Initialize the module:

   const mcp = require('meilisearch-mcp-server');
   

3. Start the service:

   mcp.startServer(3000);
   

Configuration Options

mcp.configure({
  host: 'localhost',
  port: 3000,
  logging: true,
  api_key: 'your_api_key'
});

Error Handling

Common Errors

mcp.getIndex('nonexistent_index').catch(err => console.error(err.message));

mcp.search('your_index', 'invalid_query').catch(err => console.error(err.status, err.data));

Complete Code Examples

Simple Example

const mcp = require('meilisearch-mcp-server');

async function main() {
  await mcp.createIndex('test_index');
  const result = await mcp.search('test_index', 'test_query');
  console.log(result);
}

main().catch(console.error);

Complex Example

const mcp = require('meilisearch-mcp-server');

async function main() {
  // Create an index
  await mcp.createIndex('complex_search');

  // Add documents
  const documents = [
    { id: 1, title: 'Introduction to Node.js', content: 'Learn Node.js basics.' },
    { id: 2, title: 'Advanced React Patterns', content: 'Master React techniques.' }
  ];
  await mcp.addDocuments('complex_search', documents);

  // Advanced search
  const result = await mcp.advancedSearch('complex_search', {
    bool: {
      must: [
        { term: { field: 'status', value: 'active' } },
        { match_phrase: { field: 'content', value: 'Learn Node.js' } }
      ]
    }
  });

  console.log(result);
}

main().catch(console.error);

API Documentation

• MCP Server API
• Meilisearch Official Documentation

Community Resources

• GitHub Repository
• Discussion Forum

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🌟 Contribution Guide

Welcome to fork the repository and submit Pull Requests!