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

探索

Searchcraft MCP Server

Searchcraft MCP服务器是一个基于Searchcraft垂直搜索引擎的工具套件，用于管理文档、索引、联邦、访问密钥和分析数据，支持通过自然语言指令执行管理操作。

搜索工具开发者工具 #搜索管理 #文档索引 #密钥控制 #数据分析 .TypeScript

评分 : 2.5分

下载量 : 4.8K

更新时间 : 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"
      ]
    }
  }
}