使用说明
项目简介
Kagi MCP服务器是一个后端应用,实现了模型上下文协议(MCP),旨在为大型语言模型(LLM)客户端提供由Kagi搜索API驱动的网页搜索功能。它将Kagi的搜索功能作为工具暴露出来,供LLM调用,以增强其上下文信息并提供更全面的回应。
主要功能点
- 网页搜索工具: 提供 'ask_fastgpt'、'enrich_web' 和 'enrich_news' 工具,分别用于执行网页搜索并获取答案、增强通用网页内容上下文以及增强新闻内容上下文,所有功能均由 Kagi API 提供支持。
- MCP 服务器: 完全实现了模型上下文协议,确保与兼容 MCP 协议的 LLM 客户端进行标准化通信。
- 工具管理: 注册和管理搜索工具,允许 LLM 客户端发现并利用这些工具。
- 配置: 需要 Kagi API 密钥进行身份验证,并支持日志级别配置。
安装步骤
- 克隆仓库: 使用 Git 克隆 GitHub 仓库到本地:
git clone https://github.com/apridachin/kagi-search-mcp - 进入项目目录: 导航到克隆下来的项目目录:
cd kagi-search-mcp - 安装依赖: 根据仓库 'README.md' 文件的指示,使用 'uv sync' 命令同步依赖并更新 lockfile:
(如果 'uv' 未安装,可能需要根据项目实际依赖情况使用 'pip install -r requirements.txt',但当前仓库信息中未包含 'requirements.txt',因此推荐使用 'uv sync')。uv sync - 设置环境变量: Kagi MCP 服务器需要 Kagi API 密钥才能工作。您需要设置 'KAGI_API_KEY' 环境变量。推荐在项目根目录下创建 '.env' 文件,并添加以下内容,将 'YOUR_API_KEY' 替换为您的实际 Kagi API 密钥:
KAGI_API_KEY=YOUR_API_KEY
服务器配置
要将 Kagi MCP 服务器与 MCP 客户端(如 Claude Desktop)配合使用,您需要在客户端中配置服务器连接信息。以下是一个 JSON 格式的配置示例,您需要将其添加到 MCP 客户端的服务器配置中。
{ "server_name": "kagi-mcp", // 服务器名称,可以自定义,用于在客户端中标识 "command": "uv", // 启动服务器的命令,这里使用 uv "args": [ // 传递给 uv 命令的参数 "--directory", // 指定工作目录 "path_to_project", // **请替换为实际的项目路径**, 例如 "/path/to/kagi-search-mcp" "run", // uv 的子命令,表示运行 "kagi-mcp" // 要运行的脚本或模块名,对应项目中的入口点 ], "env": { // 环境变量配置 "KAGI_API_KEY": "YOUR API KEY" // **请替换为您的 Kagi API 密钥**, 也可以在系统环境变量中设置 } }
配置参数说明:
- '"server_name"': 为您的 MCP 服务器实例设置一个名称,例如 "kagi-mcp",此名称将在 MCP 客户端中用于识别和管理服务器连接。
- '"command"': 指定用于启动 MCP 服务器的命令。根据仓库配置,这里使用 'uv' 作为包管理和运行工具。
- '"args"': 一个字符串数组,包含传递给 '"command"' 的参数。
- '"--directory"': 指示 'uv' 在指定的目录下运行命令。
- '"path_to_project"': 重要: 您需要将 '"path_to_project"' 替换为 Kagi MCP 服务器项目在您本地文件系统中的绝对路径。例如,如果您的项目位于 '/Users/yourusername/Documents/kagi-search-mcp',则应替换为 '"/Users/yourusername/Documents/kagi-search-mcp"'。
- '"run"': 'uv run' 命令用于执行指定的 Python 模块或脚本。
- '"kagi-mcp"': 指定要运行的模块名称,这通常对应于项目入口点,根据 'src/kagi_mcp/init.py' 和 'pyproject.toml' (未显示,但从构建过程推断) 配置,'kagi-mcp' 指向 'src/kagi_mcp/init.py' 中的 'main' 函数,从而启动服务器。
- '"env"': 一个键值对对象,用于设置服务器进程运行时的环境变量。
- '"KAGI_API_KEY"': 您的 Kagi API 密钥。重要: 请将 '"YOUR API KEY"' 替换为您的实际 Kagi API 密钥。您也可以选择在操作系统的环境变量中设置 'KAGI_API_KEY',如果这样做,可以从此处移除 '"env"' 部分或删除 '"KAGI_API_KEY"' 键值对。
基本使用方法
- 启动服务器: 根据上述配置,在您的 MCP 客户端中启动 Kagi MCP 服务器。客户端会使用您提供的命令和参数来运行服务器。
- 客户端连接: 确保您的 MCP 客户端已正确配置并成功连接到 Kagi MCP 服务器。
- 使用工具: 在您的 LLM 客户端中,您现在应该能够使用由 Kagi MCP 服务器提供的工具:'ask_fastgpt'、'enrich_web' 和 'enrich_news'。具体使用方法请参考您的 LLM 客户端的文档,通常您可以通过指定工具名称和相应的参数来调用这些工具,以实现网页搜索和上下文增强功能。
信息
分类
网页与API