MCP Meilisearch

🚀 Meilisearch MCP 服务器（Go）

这是一个基于 Go 语言的 Meilisearch 搜索引擎包装器，可作为模型上下文协议 (MCP) 服务器运行，让大型语言模型能借助其强大搜索能力。

🚀 快速开始

该项目是用 Go 编写的应用程序，目的是让 Meilisearch 搜索引擎能作为 MCP（模型上下文协议）服务器使用。借助 MCP 服务器，大型语言模型（如 Claude）就能访问 Meilisearch 强大的搜索功能。

✨ 主要特性

• ⚡轻量级且快速的 MCP 服务器，由 Go 语言实现。
• 🛠️与 Meilisearch API 无缝集成。
• 📄符合 MCP 协议的接口。
• 🗄️支持关键功能，涵盖搜索、索引管理及文档操作。

📦 安装指南

先决条件

• Go 1.24 或更高版本。
• 正在运行的 Meilisearch 实例。

构建说明

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

# 安装依赖项
make deps

# 构建
make bin/mcp-meilisearch

💻 使用示例

启动服务器

./bin/mcp-meilisearch server --config config.yml

选项：

• --no-logs：最小化日志输出（仅显示错误）。
• --log <文件路径>：将日志输出到指定文件。

与 Claude Desktop 集成

要在 Claude Desktop 中使用，需在 claude_desktop_config.json 文件中添加一个 MCP 服务器条目。由于 MCP 使用 stdio 进行通信，您必须通过 --no-logs 和 --log 标志将日志重定向到文件。以下是配置示例：

{
  "mcpServers": {
    "sqlite": {
      "command": "./bin/mcp-meilisearch",
      "args": ["server", "--no-logs", "--log", "path_to_log_file"],
      "env": {
        "MEILISEARCH_HOST": "http://localhost:7700",
        "MEILISEARCH_API_KEY": "api_key"
      }
    }
  }
}

此配置会将 Meilisearch MCP 服务器注册到 Claude Desktop，并确保日志正确重定向。

📚 详细文档

配置

使用 config.yml 文件配置与 Meilisearch 服务器的连接设置：

meilisearch:
  host: http://localhost:7700 # Meilisearch 服务器地址
  api_key: '' # 如需设置 API 密钥

您也可以通过环境变量进行配置：

• MEILISEARCH_HOST：Meilisearch 服务器地址。
• MEILISEARCH_API_KEY：Meilisearch API 密钥。

工具说明

健康检查

• 用途：验证服务器运行状态。
• 参数：无。
• 返回值：成功时返回 ok，失败时返回错误信息。

索引管理

创建索引

• 用途：创建新索引。
• 参数：
  • index_name：新索引的名称。
• 请求体（JSON）：

{
  "name": "string", // 索引名称
  "options": { // 可选配置，如分片数量、副本数等 }
}

• 返回值：新索引的信息。

删除索引

• 用途：删除指定索引。
• 参数：
  • index_name：要删除的索引名称。
• 请求体：无。
• 返回值：删除成功时无内容，失败时返回错误信息。

文档操作

添加文档

• 用途：在指定索引中添加或更新文档。
• 参数：
  • index_name：索引名称。
  • document_id（可选）：文档 ID，默认自动生成。
• 请求体（JSON）：

{
  "fields": { // 文档字段内容 }
}

• 返回值：插入或更新的文档信息。

批量添加文档

• 用途：在指定索引中批量添加或更新多个文档。
• 参数：
  • index_name：索引名称。
• 请求体（JSON）：

[
  {
    "id": "string", // 文档 ID
    "fields": { // 文档字段内容 }
  },
  ...
]

• 返回值：批量操作结果，包括成功和失败的文档信息。

🤝 贡献指南

提交代码

1. 创建功能分支。
2. 提交更改并撰写提交信息。
3. 提交至主分支或标记为待审。

提交规范

遵循以下规范：

• 每个提交对应一个独立的功能或修复。
• 提交信息简洁明了，反映变更内容。
• 代码需通过所有测试用例。

📄 许可证

本项目采用 MIT License。

如需更多信息，请访问项目地址：https://github.com/cnosuke/mcp-meilisearch