Meilisearch AI助手协议
通过模型上下文协议,启用AI助手与Meilisearch的交互,允许通过标准化接口进行全面的索引、文档和搜索管理。
服务介绍
Meilisearch MCP 服务器
这是一个为 Meilisearch 实现的模型上下文协议 (MCP) 服务器,使 AI 助手能够通过标准化接口与 Meilisearch 进行交互。
特性
- 索引管理:创建、更新和删除索引
- 文档管理:添加、更新和删除文档
- 搜索功能:使用各种参数和过滤器执行搜索
- 设置管理:配置索引设置
- 任务管理:监控和管理异步任务
- 系统操作:健康检查、版本信息和统计
- 向量搜索:实验性的向量搜索功能
安装
通过 Smithery 安装
要通过 Smithery 自动为 Claude 桌面版安装 Meilisearch MCP 服务器:
npx -y @smithery/cli install @devlimelabs/meilisearch-ts-mcp --client claude
手动安装
-
克隆仓库:
git clone https://github.com/devlimelabs/meilisearch-ts-mcp.git cd meilisearch-ts-mcp -
安装依赖项:
npm install -
基于示例文件创建一个
.env文件:cp .env.example .env -
编辑
.env文件以配置您的 Meilisearch 连接。
Docker 设置
Meilisearch MCP 服务器可以在 Docker 容器中运行,以便更轻松地部署和隔离。
使用 Docker Compose
开始使用 Docker 的最简单方法是使用 Docker Compose:
# Start the Meilisearch MCP Server
docker-compose up -d
# View logs
docker-compose logs -f
# Stop the server
docker-compose down
手动构建和运行 Docker 镜像
您也可以手动构建和运行 Docker 镜像:
# Build the Docker image
docker build -t meilisearch-ts-mcp .
# Run the container
docker run -p 3000:3000 --env-file .env meilisearch-ts-mcp
开发设置
对于希望为 Meilisearch MCP 服务器做出贡献的开发者,我们提供了一个方便的设置脚本:
# Clone the repository
git clone https://github.com/devlimelabs-ts-mcp/meilisearch-ts-mcp.git
cd meilisearch-ts-mcp
# Run the development setup script
./scripts/setup-dev.sh
设置脚本将:
- 如果不存在,则从
.env.example创建一个.env文件 - 安装依赖项
- 构建项目
- 运行测试以确保一切正常工作
运行设置脚本后,您可以以开发模式启动服务器:
npm run dev
使用
构建项目
npm run build
运行服务器
npm start
开发模式
npm run dev
Claude 桌面版集成
Meilisearch MCP 服务器可以与 Claude 桌面版集成,允许您直接通过 Claude 与您的 Meilisearch 实例进行交互。
自动设置
我们提供了一个设置脚本,该脚本会自动配置 Claude 桌面版以与 Meilisearch MCP 服务器一起工作:
# First build the project
npm run build
# Then run the setup script
node scripts/claude-desktop-setup.js
脚本将:
- 检测您的操作系统并找到 Claude 桌面版的配置文件
- 从
.env文件读取您的 Meilisearch 配置 - 生成 Claude 桌面版所需的配置
- 提供更新 Claude 桌面版配置的说明
手动设置
如果您更喜欢手动配置 Claude 桌面版:
-
找到你的 Claude for Desktop 配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
- macOS:
-
添加以下配置(根据需要调整路径):
{
"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"
}
}
}
}
-
重启 Claude for Desktop 以应用更改。
-
在 Claude 中输入: "I want to use the Meilisearch MCP server" 以激活集成。
Cursor 集成
Meilisearch MCP 服务器也可以与 Cursor(一款由 AI 支持的代码编辑器)集成。
在 Cursor 中设置 MCP
-
安装并设置 Meilisearch MCP 服务器:
git clone https://github.com/devlimelabs/meilisearch-ts-mcp.git cd meilisearch-ts-mcp npm install npm run build -
启动 MCP 服务器:
npm start -
在 Cursor 中打开命令面板(Cmd/Ctrl+Shift+P),搜索 "MCP: Connect to MCP Server"。
-
选择 "Connect to a local MCP server" 并输入以下详细信息:
- 名称: Meilisearch
- 命令: node
- 参数: /absolute/path/to/meilisearch-ts-mcp/dist/index.js
- 环境变量:
MEILISEARCH_HOST=http://localhost:7700 MEILISEARCH_API_KEY=your-api-key
-
点击 "连接" 以建立连接。
-
现在你可以通过在 Cursor 中输入类似 "Search my Meilisearch index for documents about..." 的命令来与你的 Meilisearch 实例进行交互。
可用工具
Meilisearch MCP 服务器提供了以下工具:
索引工具
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