使用说明
项目简介
Meilisearch MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议与 Meilisearch 搜索引擎进行交互。该服务器充当 LLM 和 Meilisearch 之间的桥梁,使得 LLM 应用可以方便地利用 Meilisearch 的搜索和数据管理功能。
主要功能点
- 连接管理: 动态配置和管理 Meilisearch 服务器连接。
- 索引管理: 创建、列出和管理 Meilisearch 索引。
- 文档操作: 在索引中添加和检索文档。
- 搜索功能: 在单个或多个索引中执行灵活的搜索查询。
- 设置管理: 管理索引的设置,如排名规则和可搜索属性。
- API 密钥管理: 管理 Meilisearch API 密钥。
- 任务管理: 监控和管理 Meilisearch 任务。
- 系统监控: 提供 Meilisearch 服务器的健康状态和系统信息。
安装步骤
- 克隆仓库:
(将 '<repository_url>' 替换为仓库地址:https://github.com/meilisearch/meilisearch-mcp)git clone <repository_url> - 进入项目目录:
cd meilisearch-mcp - 创建并激活虚拟环境:
uv venv source .venv/bin/activate # Linux/macOS .venv\Scripts\activate # Windows - 安装项目依赖:
uv pip install -e .
服务器配置
要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,您需要在客户端的配置文件中添加服务器配置信息。以下是一个示例 'claude_desktop_config.json' 配置,用于配置 Meilisearch MCP 服务器:
{ "mcpServers": { "meilisearch": { "command": "uvx", "args": ["-n", "meilisearch-mcp"] } } }
- 'server name': 'meilisearch' (服务器名称,客户端用于标识和调用)
- 'command': 'uvx' (启动服务器的命令,这里使用 'uvx' 运行 Python 模块,uvx 需要提前安装,可以使用 'pip install uv' 安装)
- 'args': '["-n", "meilisearch-mcp"]' (传递给命令的参数,'-n meilisearch-mcp' 表示运行 'src.meilisearch_mcp' 模块)
基本使用方法
- 配置 Meilisearch 连接:
- 默认情况下,服务器连接到 'http://localhost:7700' 的 Meilisearch 实例。
- 您可以通过设置环境变量来更改 Meilisearch 的 URL 和 API 密钥:
export MEILI_HTTP_ADDR=http://your_meilisearch_url:7700 # 设置 Meilisearch URL export MEILI_MASTER_KEY=your_master_key # 设置 Meilisearch API 密钥 (可选)
- 启动 MCP 服务器:
- 运行命令 'python -m src.meilisearch_mcp' 或 'uvx -n meilisearch-mcp' 启动服务器。
- 在 MCP 客户端中使用:
- 在您的 MCP 客户端(例如 Claude Desktop)中配置上述服务器配置。
- 客户端将通过 MCP 协议与此服务器通信,并可以使用服务器提供的工具来操作 Meilisearch。
- 例如,您可以指示 LLM 客户端使用 'search' 工具在 Meilisearch 中执行搜索。
信息
分类
网页与API