Searchcraft MCP服務器 - 垂直搜索管理工具套件，支持自然語言指令執行管理操作

Searchcraft MCP Server

Searchcraft MCP服務器是一個基於Searchcraft垂直搜索引擎的工具套件，用於管理文檔、索引、聯邦、訪問密鑰和分析數據，支持通過自然語言指令執行管理操作。

搜索工具開發者工具 #搜索管理 #文檔索引 #密鑰控制 #數據分析 .TypeScript

評分 : 2.5分

下載量 : 0

更新時間 : 2025-07-23

什麼是searchcraft-mcp-server?

searchcraft-mcp-server是一個基於Searchcraft的MCP服務器，提供了一套工具來管理您的Searchcraft集群中的文檔、索引、聯邦、訪問密鑰和分析。它允許MCP客戶端（如Claude Desktop）通過自然語言提示執行管理操作。

如何使用searchcraft-mcp-server?

要使用searchcraft-mcp-server，您需要在本地運行服務器，並將其與Claude Desktop等MCP客戶端連接。通過配置環境變量並啟動服務器，您可以利用其提供的各種功能進行索引管理、文檔操作和訪問密鑰控制。

適用場景

該服務器適用於需要管理Searchcraft集群的開發人員、數據工程師和系統管理員。它可以用於設置搜索索引、添加文檔、查看分析、刪除文檔以及管理訪問密鑰等任務。

主要功能

索引管理支持創建、刪除、更新和查詢索引，包括索引模式和統計信息獲取。

文檔管理可以添加、刪除、查詢和更新文檔，支持按ID或字段刪除文檔。

聯邦管理提供創建、更新和刪除聯邦的功能，支持查看聯邦詳細信息和統計信息。

認證與密鑰管理能夠創建、刪除和更新訪問密鑰，支持按組織、應用或聯邦篩選密鑰。

停用詞與同義詞管理允許添加、刪除和查看索引中的停用詞和同義詞。

搜索與測量支持執行搜索查詢、獲取測量轉換和摘要數據。

優勢與侷限性

優勢

提供直觀的API接口，便於集成到其他應用程序中。

支持多種管理操作，簡化了Searchcraft集群的維護工作。

兼容Claude Desktop等MCP客戶端，提升用戶體驗。

侷限性

需要一定的技術背景來配置和運行服務器。

對於非技術人員來說，部分命令和參數可能較難理解。

依賴於Searchcraft集群的可用性，若集群不可用則無法操作。

如何使用

配置環境變量

在項目根目錄創建一個名為.env的文件，並填寫以下內容：

安裝依賴

使用yarn安裝項目依賴：

構建並啟動服務器

構建並啟動服務器：

連接Claude Desktop

在Claude Desktop配置文件中添加MCP服務器配置：

使用案例

創建索引為新的搜索需求創建一個索引，並定義其模式。

添加文檔將一批文檔添加到已有的索引中，以便後續搜索。

刪除文檔從索引中刪除特定文檔，以清理過時或無效數據。

常見問題

我需要什麼環境才能運行searchcraft-mcp-server?

如何確保Claude Desktop正確連接到服務器?

如果遇到錯誤，如何調試？

🚀 searchcraft-mcp-server

searchcraft-mcp-server 是一個由 Searchcraft 驅動的 MCP 服務器。Searchcraft 是一款以開發者為中心的垂直搜索引擎。該服務器提供了一套工具，用於管理 Searchcraft 集群的文檔、索引、聯合搜索、訪問密鑰和分析數據。

🚀 快速開始

環境變量

在項目根目錄下創建 .env 文件，並填寫以下值：

# 服務器配置
USER_AGENT=searchcraft-mcp-server/<項目版本>
DEBUG=true
PORT=3100

# Searchcraft 配置
ENDPOINT_URL= # Searchcraft 集群的端點 URL
ADMIN_KEY= # Searchcraft 集群的管理員密鑰（超級用戶密鑰）

.env 文件示例

運行服務器

確保你的環境中選擇了正確版本的 Node：

nvm use

使用 Yarn 安裝依賴：

yarn

構建並啟動服務器：

yarn build
yarn start

✨ 主要特性

可用工具

索引管理

工具名稱	描述
create_index	使用指定的架構創建新索引。如果索引已存在，則會清空該索引。
delete_index	永久刪除索引及其所有文檔。
get_all_index_stats	獲取所有索引的文檔計數和統計信息。
get_index_schema	獲取特定索引的架構定義。
get_index_stats	獲取特定索引的統計信息和元數據（如文檔計數等）。
list_all_indexes	獲取 Searchcraft 實例中所有索引的列表。
patch_index	對索引架構進行部分配置更改（如搜索字段、權重乘數等）。
update_index	用新的架構定義替換現有索引的全部內容。

文檔管理

工具名稱	描述
add_documents	向索引中添加一個或多個文檔。文檔應以 JSON 對象數組的形式提供。
delete_all_documents	刪除索引中的所有文檔。刪除所有文檔後，索引仍將存在。
delete_document_by_id	根據文檔的內部 Searchcraft ID（_id）從索引中刪除單個文檔。
delete_documents_by_field	根據字段項匹配從索引中刪除一個或多個文檔（例如，{id: 'xyz'} 或 {title: 'foo'}）。
delete_documents_by_query	根據查詢匹配從索引中刪除一個或多個文檔。
get_document_by_id	根據文檔的內部 Searchcraft ID（_id）從索引中獲取單個文檔。

聯合搜索管理

工具名稱	描述
create_federation	使用指定的配置創建或更新聯合搜索。
delete_federation	永久刪除聯合搜索。
get_federation_details	獲取特定聯合搜索的詳細信息。
get_federation_stats	獲取聯合搜索中每個索引的文檔計數以及總文檔計數。
get_organization_federations	獲取特定組織的所有聯合搜索列表。
list_all_federations	獲取 Searchcraft 實例中所有聯合搜索的列表。
update_federation	用更新後的聯合搜索實體替換當前的聯合搜索實體。

認證與密鑰管理

工具名稱	描述
create_key	創建具有指定權限和訪問控制的新認證密鑰。
delete_all_keys	刪除 Searchcraft 集群上的所有認證密鑰。請謹慎使用！
delete_key	永久刪除特定的認證密鑰。
get_application_keys	獲取與特定應用程序關聯的所有認證密鑰列表。
get_federation_keys	獲取與特定聯合搜索關聯的所有認證密鑰列表。
get_key_details	獲取特定認證密鑰的詳細信息。
get_organization_keys	獲取與特定組織關聯的所有認證密鑰列表。
list_all_keys	獲取 Searchcraft 集群上的所有認證密鑰列表。
update_key	用新的配置更新現有的認證密鑰。

停用詞管理

工具名稱	描述
add_stopwords	向索引中添加自定義停用詞。這些停用詞會添加到默認的特定語言詞典之上。
delete_all_stopwords	刪除索引中的所有自定義停用詞。這僅影響自定義停用詞，不影響默認的語言詞典。
delete_stopwords	從索引中刪除特定的自定義停用詞。這僅影響自定義停用詞，不影響默認的語言詞典。
get_index_stopwords	獲取索引的所有停用詞，包括默認的語言詞典和自定義停用詞。

同義詞管理

工具名稱	描述
add_synonyms	向索引中添加同義詞。同義詞僅適用於模糊查詢，不適用於精確匹配查詢。
delete_all_synonyms	刪除索引中的所有同義詞。
delete_synonyms	根據同義詞的鍵從索引中刪除特定的同義詞。
get_index_synonyms	獲取為索引定義的所有同義詞。

搜索與測量

工具名稱	描述
get_measure_conversion	獲取測量轉換數據，可選擇過濾和聚合參數。
get_measure_summary	獲取測量摘要數據，可選擇過濾和聚合參數。
get_search_results	使用 Searchcraft API 執行搜索查詢，支持模糊/精確匹配、分面和日期範圍。
get_searchcraft_status	獲取 Searchcraft 搜索服務的當前狀態。

💻 使用示例

與 Claude Desktop 配合使用

為了讓 Claude Desktop 檢測到 searchcraft-mcp-server 的工具，服務器必須處於運行狀態。

searchcraft-mcp-server 使用 StreamableHTTPServerTransport，因此為了將其連接到 Claude Desktop，我們使用 mcp-remote ↗︎。

在你的 Claude Desktop 配置文件中添加以下內容：

claude_desktop_config.json

{
  "mcpServers": {
    "searchcraft": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://localhost:<MY-PORT-FROM-ENV>/mcp"
      ]
    }
  }
}