Meilisearch MCP Server

这是一个用于 Meilisearch 的模型上下文协议（MCP）服务器实现，使AI助手能够通过标准化接口与 Meilisearch 进行交互。

功能

• 索引管理：创建、更新和删除索引
• 文档管理：添加、更新和删除文档
• 搜索功能：使用各种参数和过滤器进行搜索
• 设置管理：配置索引设置
• 任务管理：监控和管理异步任务
• 系统操作：健康检查、版本信息和统计
• 向量搜索：实验性的向量搜索能力

安装

通过 Smithery 安装

要通过 Smithery 自动安装 Meilisearch MCP Server：

npx -y @smithery/cli install @devlimelabs/meilisearch-ts-mcp --client claude

手动安装

1. 克隆仓库：

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

2. 安装依赖项：

   npm install
   

3. 根据示例创建 .env 文件：

   cp .env.example .env
   

4. 编辑 .env 文件以配置您的 Meilisearch 连接。

Docker 配置

Meilisearch MCP Server 可以在 Docker 容器中运行，以便于部署和隔离。

使用 Docker Compose

使用 Docker Compose 是开始使用 Docker 的最简单方法：

# 启动 Meilisearch MCP Server
docker-compose up -d

# 查看日志
docker-compose logs -f

# 停止服务
docker-compose down

手动构建和运行 Docker 镜像

您也可以手动构建和运行 Docker 镜像：

# 构建 Docker 镜像
docker build -t meilisearch-ts-mcp .

# 运行容器
docker run -p 3000:3000 --env-file .env meilisearch-ts-mcp

开发环境配置

对于希望为 Meilisearch MCP Server 贡献代码的开发者，我们提供了一个方便的设置脚本：

# 克隆仓库
git clone https://github.com/devlimelabs-ts-mcp/meilisearch-ts-mcp.git
cd meilisearch-ts-m

设置脚本会：

1. 如果不存在，则从 .env.example 创建一个 .env 文件
2. 安装依赖项
3. 构建项目
4. 运行测试以确保一切正常工作

运行设置脚本后，您可以启动开发模式下的服务器：

npm run dev

使用

构建项目

npm run build

运行服务器

npm start

开发模式

npm run dev

Claude Desktop 集成

Meilisearch MCP Server 可以集成到 Claude Desktop 中，允许您直接通过 Claude 与 Meilisearch 实例进行交互。

自动设置

我们提供了一个设置脚本，可以自动配置 Claude Desktop 以与 Meilisearch MCP Server 一起工作：

# 首先构建项目
npm run build

# 然后运行设置脚本
node scripts/claude-desktop-setup.js

该脚本会：

1. 检测您的操作系统并定位 Claude Desktop 配置文件
2. 从 .env 文件读取您的 Meilisearch 配置
3. 生成 Claude Desktop 所需的配置
4. 提供更新 Claude Desktop 配置的说明

手动设置

如果您更喜欢手动配置 Claude Desktop：

1. 定位您的 Claude Desktop 配置文件：

   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%\Claude\claude_desktop_config.json
   • Linux：~/.config/Claude/claude_desktop_config.json

2. 添加以下配置（根据需要调整路径）：

{
  "mcpServers": {
    "meilisearch": {
      "command": "node",
      "args": ["/path/to/meilisearch-ts-mcp/dist/index.js"],
      "env": {
        "MEILISEARCH_HOST": "http://localhost:7700",
        "MEILISEARCH_API_KEY": "your-api-key"
      }
    }
  }
}

3. 重启 Claude Desktop 以应用更改。

4. 在 Claude 中键入：“我想使用 Meilisearch MCP 服务器”以激活集成。

Cursor 集成

Meilisearch MCP Server 还可以集成到 Cursor，这是一个由 AI 驱动的代码编辑器。

在 Cursor 中设置 MCP

1. 安装并设置 Meilisearch MCP Server：

   git clone https://github.com/devlimelabs/meilisearch-ts-mcp.git
   cd meilisearch-ts-mcp
   npm install
   npm run build
   

2. 启动 MCP 服务器：

   npm start
   

3. 在 Cursor 中打开命令面板（Cmd/Ctrl+Shift+P），搜索“MCP: 连接到 MCP 服务器”。

4. 选择“连接到本地 MCP 服务器”，并输入以下详细信息：

   • 名称：Meilisearch
   • 命令：node
   • 参数：/绝对路径/to/meilisearch-ts-mcp/dist/index.js
   • 环境变量：

     MEILISEARCH_HOST=http://localhost:7700
     MEILISEARCH_API_KEY=your-api-key
     

5. 点击“连接”以建立连接。

6. 您现在可以通过在 Cursor 中键入类似“在我的 Meilisearch 索引中搜索关于...的文档”这样的命令来与您的 Meilisearch 实例进行交互。

可用工具

Meilisearch MCP Server 提供了以下工具：

索引工具

• create-index：创建新索引
• get-index：获取索引信息
• list-indexes：列出所有索引
• update-index：更新索引
• delete-index：删除索引

文档工具

• add-documents：向索引添加文档
• get-document：通过ID获取文档
• get-documents：获取多个文档
• update-documents：更新文档
• delete-document：通过ID删除文档
• delete-documents：删除多个文档
• delete-all-documents：删除索引中的所有文档

搜索工具

• search：搜索文档
• multi-search：在一个请求中执行多次搜索

设置工具

• get-settings：获取索引设置
• update-settings：更新索引设置
• reset-settings：重置索引设置为默认值
• 各种特定设置工具（同义词、停用词、排名规则等）

任务工具

• list-tasks：列出任务，可选过滤
• get-task：获取特定任务的信息
• cancel-tasks：基于提供的过滤器取消任务
• wait-for-task：等待特定任务完成

系统工具

• health：检查 Meilisearch 服务器的健康状态
• version：获取版本信息
• info：获取系统信息
• stats：获取有关索引的统计信息

向量工具（实验性）

• enable-vector-search：启用向量搜索
• get-experimental-features：获取实验性功能的状态
• update-embedders：配置嵌入器
• get-embedders：获取嵌入器配置
• reset-embedders：重置嵌入器配置
• vector-search：执行向量搜索

许可证

MIT