此项目是一个Model Context Protocol (MCP) 服务器,用于将SearchUnify的搜索功能集成到兼容MCP的AI客户端(如Claude桌面版),使AI能够利用SearchUnify的知识库获取上下文信息。
主要功能点
- 搜索集成: 使AI可以直接搜索您的SearchUnify索引,获取相关文档和信息。
- 安全访问控制: 通过OAuth 2.0协议确保对SearchUnify的安全访问。
- Docker容器化部署: 提供便捷的安装和运行方式,简化配置过程。
安装步骤
- 获取SearchUnify凭据: 准备好您的SearchUnify实例URL、OAuth 2.0用户名、密码、客户端ID、客户端Secret以及Search Client UID。确保这些凭据拥有执行搜索操作所需的API权限。
- 创建配置文件: 在本地创建一个名为'creds.json'的文件,将您的SearchUnify凭据信息以JSON格式保存在其中。请参考仓库README中的示例格式,将占位符替换为您的实际值。
- 安装Docker: 确保您的系统已安装Docker。
- 配置AI客户端: 找到您的AI客户端(例如Claude桌面版)的配置文件(通常是'claude_desktop_config.json'),在'mcpServers'部分添加对'su-mcp'服务器的配置。
- 重启AI客户端: 保存配置并重启AI客户端,使其加载新的服务器配置。
MCP服务器配置(客户端侧)
AI客户端通过配置来连接MCP服务器。您需要在客户端的配置文件(如'claude_desktop_config.json')中找到MCP服务器配置部分(通常是'mcpServers'),并添加一个名为'su-mcp'的条目。该条目需要包含:
- 'command': 指定启动服务器的程序。对于此项目,如果您使用Docker运行,这将是'docker'。
- 'args': 启动命令的参数列表。这通常包括'docker run'所需的参数,如指定交互模式、自动清理以及最重要的一点:将您创建的'creds.json'文件的本地路径映射到Docker容器内部一个固定的路径(例如'/input/creds.json')。您需要将'<path_to_creds.json>'替换为您实际的'creds.json'文件所在的完整路径。
例如,参数列表可能类似于指定Docker运行命令、交互模式、自动移除容器、将本地'/您的/本地/路径/creds.json'文件映射到容器内的'/input/creds.json'并设为只读,最后指定要运行的Docker镜像名称'searchunifyutils/su-mcp'。具体的参数格式和配置方法请务必参考您所使用AI客户端的官方文档。
基本使用方法
配置完成后,重启AI客户端。当您与AI交互时,如果需要SearchUnify中的信息来回答问题或提供上下文,AI客户端可能会自动或根据您的指令调用'su-mcp'服务器提供的搜索工具。服务器将通过SearchUnify执行搜索,并将结果返回给AI客户端,供AI使用。
信息
分类
AI与计算