MCP Meilisearch

🚀 Meilisearch MCP Server (Go)

A wrapper for the Meilisearch search engine written in Go, running as a Model Context Protocol (MCP) server.

🚀 Quick Start

This project is an application written in Go, aiming to enable the Meilisearch search engine to be used as an MCP (Model Context Protocol) server. Through the MCP server, large language models (such as Claude) can access the powerful search capabilities of Meilisearch.

✨ Features

• A lightweight and fast MCP server implemented in Go.
• Seamless integration with the Meilisearch API.
• Interfaces compliant with the MCP protocol.
• Support for key functions, including search, index management, and document operations.

📦 Installation

Prerequisites

• Go 1.24 or higher.
• A running Meilisearch instance.

Build Instructions

# Clone the repository
git clone https://github.com/cnosuke/mcp-meilisearch.git
cd mcp-meilisearch

# Install dependencies
make deps

# Build
make bin/mcp-meilisearch

📚 Documentation

Configuration

Use the config.yml file to configure the connection settings with the Meilisearch server:

meilisearch:
  host: http://localhost:7700 # Meilisearch server address
  api_key: '' # Set API key if required

You can also configure via environment variables:

• MEILISEARCH_HOST: Meilisearch server address.
• MEILISEARCH_API_KEY: Meilisearch API key.

Starting the Server

./bin/mcp-meilisearch server --config config.yml

Options:

• --no-logs: Minimize log output (only show errors).
• --log <file path>: Redirect log output to the specified file.

Integration with Claude Desktop

To use it in Claude Desktop, add an MCP server entry to the claude_desktop_config.json file. Since MCP uses stdio for communication, you must redirect logs to a file using the --no-logs and --log flags. Here is a configuration example:

{
  "mcpServers": {
    "sqlite": {
      "command": "./bin/mcp-meilisearch",
      "args": ["server", "--no-logs", "--log", "path_to_log_file"],
      "env": {
        "MEILISEARCH_HOST": "http://localhost:7700",
        "MEILISEARCH_API_KEY": "api_key"
      }
    }
  }
}

This configuration registers the Meilisearch MCP server with Claude Desktop, ensuring that logs are redirected correctly.

Tool Instructions

Health Check

• Purpose: Verify the server's running status.
• Parameters: None.
• Return Value: Returns ok on success, and an error message on failure.

Index Management

Create an Index

• Purpose: Create a new index.
• Parameters:
  • index_name: The name of the new index.
• Request Body (JSON):

{
  "name": "string", // Index name
  "options": { // Optional configuration, such as the number of shards and replicas }
}

• Return Value: Information about the new index.

Delete an Index

• Purpose: Delete a specified index.
• Parameters:
  • index_name: The name of the index to be deleted.
• Request Body: None.
• Return Value: No content on successful deletion, and an error message on failure.

Document Operations

Add a Document

• Purpose: Add or update a document in a specified index.
• Parameters:
  • index_name: Index name.
  • document_id (optional): Document ID, automatically generated by default.
• Request Body (JSON):

{
  "fields": { // Document field content }
}

• Return Value: Information about the inserted or updated document.

Bulk Add Documents

• Purpose: Bulk add or update multiple documents in a specified index.
• Parameters:
  • index_name: Index name.
• Request Body (JSON):

[
  {
    "id": "string", // Document ID
    "fields": { // Document field content }
  },
  ...
]

• Return Value: Results of the bulk operation, including information about successful and failed documents.

Contribution Guidelines

Submitting Code

1. Create a feature branch.
2. Commit changes and write commit messages.
3. Submit to the main branch or mark as pending review.

Submission Specifications

Follow these specifications:

• Each commit corresponds to an independent feature or fix.
• Commit messages are concise and reflect the content of the changes.
• The code must pass all test cases.

📄 License

This project is licensed under the MIT License.

For more information, please visit the project page: https://github.com/cnosuke/mcp-meilisearch