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