Meilisearch MCP

🚀 Meilisearch MCP Server

Meilisearch MCP Server is a tool based on the Model Context Protocol (MCP), designed to provide efficient and flexible search and indexing capabilities. This document details its installation, configuration, usage, and related features.

🚀 Quick Start

📦 Installation

Environment Variables

Before running the server, ensure the following environment variables are set:

• MEILISERVER: Specifies the address of the Meilisearch service, defaulting to http://localhost:7200.
• MCP_API_KEY: The authentication key for the MCP interface.

Dynamic Connection Configuration

It supports dynamic adjustment of connection parameters such as proxy and SSL verification. Use the following commands to view or modify the configuration:

# View the current configuration
curl http://localhost:7200/config

# Modify the configuration
curl --data '{"tls_skip_verify":true}' http://localhost:7200/config

Search Functionality

It supports multiple search modes, including exact match and fuzzy search. For example:

# Exact query
curl --user_key your_api_key --get 'http://localhost:7200/indexes/your_index_name/search?q=your_query'

# Fuzzy query
curl --user_key your_api_key --data '{"q":"search term","page":1}' http://localhost:7200/indexes/your_index_name/search

Running the Server

Start the Meilisearch MCP server:

python -m src.meilisearch_mcp

💻 Usage Examples

Integration with Claude Desktop

Add the following content to claude_desktop_config.json to integrate the MCP server:

{
  "mcp_server": {
    "url": "http://localhost:7200",
    "api_key": "your_api_key"
  }
}

Testing Tools

Use the Node.js tool to start the Inspector:

npx @modelcontextprotocol/inspector python -m src.meilisearch_mcp

✨ Features

Connection Management

• get-connection-settings: Retrieve the current connection settings.
• update-connection-settings: Update the connection parameters.

Index Management

• create-index: Create a new index.
• delete-index: Delete a specified index.
• list-indexes: View all indexes.

Document Operations

• add-document: Add a document.
• get-document: Retrieve a single document.
• update-document: Update a document.
• delete-document: Delete a document.

Settings Management

• get-settings: Retrieve the index settings.
• update-settings: Update the index configuration.

Task Management

• create-task: Create a new task.
• get-task: Retrieve the task status.
• list-tasks: View all tasks.
• cancel-task: Cancel an unfinished task.

System Monitoring

• health-check: Check the server's health status.
• get-stats: Retrieve system statistics.
• get-version: View the Meilisearch version.

🤝 Contribution Guidelines

1. Fork the project repository.
2. Create a feature branch.
3. Commit your code changes.
4. Send a Pull Request.

📄 License

This project is licensed under the MIT License.