使用说明

项目简介

KiMCP (Korea-integrated Model Context Protocol) 是一个基于 Model Context Protocol (MCP) 构建的服务器实现,专注于集成韩国相关的API服务。当前版本主要集成了 Naver 搜索 API,允许LLM客户端通过调用工具的方式,便捷地搜索和获取Naver博客、新闻、咖啡馆文章等信息。该项目旨在弥合LLM在处理特定区域(如韩国)信息时的能力差距,为开发者提供一个易于使用、可扩展的MCP服务器框架。

主要功能点

  • Naver 博客搜索 (search_blog): 允许LLM根据关键词在Naver博客平台搜索相关博文,并返回包含标题、链接、摘要、博主信息等详细结果。
  • Naver 新闻搜索 (search_news): 允许LLM根据关键词在Naver新闻平台搜索最新资讯,并返回包含新闻标题、原始链接、Naver链接、摘要、发布时间等详细结果。
  • Naver 咖啡馆文章搜索 (search_cafe_article): 允许LLM根据关键词在Naver咖啡馆平台搜索文章,并返回包含文章标题、链接、摘要、咖啡馆名称和URL等详细结果。
  • 易于安装和配置: 提供简单的安装步骤,并使用'.env'文件管理API密钥等敏感信息。
  • 开发和测试工具: 内置MCP inspector,方便开发者进行测试和调试。

安装步骤

  1. 克隆仓库

    git clone https://github.com/zeikar/kimcp
    cd kimcp
  2. 安装依赖

    uv sync
    • 确保已安装 'uv' (Python 包管理器)。
  3. 配置环境变量 创建 '.env' 文件,并填入你的 Naver API 凭据。你需要先在 Naver开发者中心 注册应用并获取 Client ID 和 Client Secret。

    echo "NAVER_CLIENT_ID=你的Naver_Client_ID" > .env
    echo "NAVER_CLIENT_SECRET=你的Naver_Client_Secret" >> .env
    • 将 '你的Naver_Client_ID' 和 '你的Naver_Client_Secret' 替换为实际的凭据。
  4. 安装到 Claude Desktop (或其他MCP客户端)

    uv run mcp install main.py -f .env
    • 假设你使用 Claude Desktop 作为 MCP 客户端。 '-f .env' 参数会将 '.env' 文件中的环境变量传递给服务器。
  5. 重启 Claude Desktop 重启 Claude Desktop 使配置生效。

服务器配置 (MCP客户端配置)

对于 MCP 客户端(例如 Claude Desktop),你需要配置连接到 KiMCP 服务器的设置。以下是一个典型的 JSON 格式配置示例,你需要将其添加到你的 MCP 客户端配置中。

{
  "server name": "KiMCP",
  "command": "uv",
  "args": ["run", "mcp", "dev", "main.py"]
}
  • server name: 服务器名称,可以自定义,例如 "KiMCP"。
  • command: 运行服务器的命令,这里使用 'uv' 启动 'mcp dev' 开发模式。 如果你希望在生产环境运行,可能需要调整命令,例如 'uv run main.py' 并配合适当的进程管理工具。
  • args: 传递给 'uv run mcp dev main.py' 命令的参数,这里 'main.py' 指定了服务器入口文件。

基本使用方法

  1. 确保 KiMCP 服务器已成功安装并配置到你的 MCP 客户端中。
  2. 在你的 LLM 应用中,你可以指示 LLM 调用 KiMCP 提供的工具,例如 'search_blog', 'search_news', 'search_cafe_article'。
  3. 根据工具的参数描述,提供相应的查询关键词和其他可选参数。
  4. LLM 将会调用 KiMCP 服务器上的工具,KiMCP 服务器会调用 Naver Search API 并将结果返回给 LLM。
  5. LLM 可以利用返回的 Naver 搜索结果进行后续的自然语言处理和应用逻辑。

例如,在支持MCP协议的LLM客户端中,安装并配置KiMCP服务器后,即可通过自然语言指令调用集成的Naver搜索工具,例如,你可以指示LLM“使用search_blog工具搜索最新的韩国美妆博客”来获取Naver博客的搜索结果。

信息

分类

网页与API