使用说明

项目简介

Meilisearch MCP 服务器是一个基于 Model Context Protocol (MCP) 的应用后端，旨在为 LLM 客户端（如 Claude, Cursor）提供 Meilisearch 搜索引擎的访问能力。通过标准化的 MCP 协议，LLM 可以安全、可扩展地利用 Meilisearch 的全文搜索和向量搜索功能。

主要功能点

索引管理：创建、更新和删除 Meilisearch 索引。
文档管理：向 Meilisearch 索引添加、更新和删除文档。
强大的搜索功能：支持关键词搜索、过滤、排序、高亮等多种搜索参数，并提供多索引搜索和向量搜索（实验性）能力。
设置管理：配置 Meilisearch 索引的各项设置，如可搜索属性、可过滤属性、同义词、停止词等。
任务管理：监控和管理 Meilisearch 的异步任务，例如索引创建、文档添加等。
系统操作：提供健康检查、版本信息、统计数据等系统级工具。

安装步骤

克隆仓库

git clone https://github.com/devlimelabs/meilisearch-ts-mcp.git
cd meilisearch-ts-mcp

安装依赖
```
npm install
```

配置环境变量 复制 '.env.example' 文件并重命名为 '.env'，根据您的 Meilisearch 实例信息修改 '.env' 文件中的配置项，例如：

MEILISEARCH_HOST=http://localhost:7700  # 您的 Meilisearch 服务器地址
MEILISEARCH_API_KEY=your-api-key      # 您的 Meilisearch API 密钥（如果需要）

构建项目
```
npm run build
```

启动服务器

npm start

或者使用开发模式启动：

npm run dev

服务器配置 (MCP 客户端)

以下是配置 MCP 客户端（例如 Claude Desktop 或 Cursor）连接到 Meilisearch MCP 服务器的示例配置信息。您需要将此配置添加到您的 MCP 客户端的配置文件中。

{
  "mcpServers": {
    "meilisearch": {                  // 服务器名称，可以自定义
      "command": "node",             // 启动服务器的命令，这里使用 Node.js 运行时
      "args": ["/path/to/meilisearch-ts-mcp/dist/index.js"], // 启动服务器的参数，指向编译后的 index.js 文件
                                                          //  请将 "/path/to/meilisearch-ts-mcp" 替换为您的 Meilisearch MCP 服务器实际的安装路径
      "env": {                       // 环境变量
        "MEILISEARCH_HOST": "http://localhost:7700", // Meilisearch 服务器地址，与 .env 文件中的配置一致
        "MEILISEARCH_API_KEY": "your-api-key"    // Meilisearch API 密钥，与 .env 文件中的配置一致
      }
    }
  }
}

注意：

请将 '"/path/to/meilisearch-ts-mcp/dist/index.js"' 替换为您 Meilisearch MCP 服务器在您本地文件系统中的 绝对路径。
环境变量 'MEILISEARCH_HOST' 和 'MEILISEARCH_API_KEY' 需要与您在 '.env' 文件中配置的 Meilisearch 连接信息保持一致。
您可以根据需要自定义 'mcpServers' 中的服务器名称 '"meilisearch"'。

基本使用方法

启动 Meilisearch MCP 服务器：确保 Meilisearch MCP 服务器已成功启动并运行。
配置 MCP 客户端：将上述服务器配置信息添加到您的 MCP 客户端（如 Claude Desktop 或 Cursor）的配置文件中。
连接到服务器：在 MCP 客户端中，根据客户端的指示连接到名为 '"meilisearch"' (或您自定义的名称) 的 MCP 服务器。
使用工具：在 LLM 应用中，您可以通过自然语言指令或特定的命令来调用 Meilisearch MCP 服务器提供的工具，例如：
- "搜索我的 Meilisearch 索引，查找关于电影的文档"
- "创建一个名为 'products' 的新索引"
- "获取 'movies' 索引的统计信息"
具体的工具名称和参数请参考仓库 README.md 文件中 "Available Tools" 章节的详细描述。

关键词