使用说明
项目简介
本项目 'webpage-summary-agent' 基于 'mcp-agent' 框架构建,旨在实现一个能够抓取网页内容并进行智能总结的应用。它利用 Model Context Protocol (MCP) 的 Agent 能力,集成了网页内容获取和 LLM 摘要生成功能,能够快速提取网页核心信息并进行总结。
主要功能点
- 网页内容抓取: 能够根据提供的URL地址,自动抓取网页的文本内容。
- LLM 智能摘要: 集成 OpenAI 的 LLM 模型 (默认 GPT-4o),对抓取的网页内容进行智能总结,提取关键信息。
- 灵活的 Agent 框架: 基于 'mcp-agent' 构建,易于扩展和定制,可以方便地集成其他 MCP Server 和工具。
- 简单的命令行接口: 通过命令行参数指定目标 URL,即可快速启动并获取网页摘要结果。
安装步骤
-
安装 uv: 根据仓库 'README.md' 提示,推荐使用 'uv' 进行环境管理。如果尚未安装 'uv',请先安装 'uv' (参考 uv 官方文档)。
-
创建虚拟环境: 在项目根目录下,使用 'uv' 创建虚拟环境:
uv venv -
安装依赖: 本项目依赖 'mcp-agent' 及其相关库,但仓库中没有明确的依赖安装步骤。通常 'mcp-agent' 会自动处理依赖安装,但如果遇到问题,可能需要手动安装 'mcp-agent' (参考 mcp-agent 仓库)。 注意: 本仓库示例代码中使用了 'OpenAIAugmentedLLM',这通常需要 'openai' Python 包,如果运行报错,请尝试手动安装 'openai':
uv pip install openai
服务器配置
本项目实际上是作为一个 MCP Agent 运行,它依赖 'mcp-agent' 框架。对于 MCP 客户端而言,可以将此项目视为一个提供网页摘要能力的 MCP 服务器。
MCP 客户端配置 (示例,假设 MCP 客户端需要连接到此摘要服务)
{ "servers": [ { "server_name": "webpage_summary_server", "command": "uv", "args": ["run", "main.py", "--url", "<目标网页URL>"], "description": "网页摘要服务,输入网页URL,返回网页内容的智能摘要。" } ] }
配置参数说明:
- 'server_name': 服务器名称,客户端用于标识和调用此服务,例如 'webpage_summary_server'。
- 'command': 启动服务器的命令,这里使用 'uv run' 来运行 'main.py' 脚本。
- 'args': 传递给 'main.py' 脚本的参数。
- '"run"': 'uv run' 的子命令,用于运行 Python 脚本。
- '"main.py"': 服务器主程序入口文件。
- '"--url"': 'main.py' 脚本接收的参数,用于指定要摘要的网页 URL。 注意: '<目标网页URL>' 需要在使用时替换为实际的网页地址。在客户端调用时,通常会将此参数动态替换。
- 'description': 服务器描述信息,方便客户端用户理解服务功能。
重要提示:
- API Key 配置: 本项目使用了 OpenAI 的 API,需要在项目根目录下创建 'mcp_agent.secrets.yaml' 文件,并配置 OpenAI API Key。请参考 'README.md' 中的 'mcp_agent.secrets.yaml' 示例进行配置。
- URL 参数: 上述 'args' 中的 '<目标网页URL>' 仅为示例,实际使用时,MCP 客户端需要根据具体需求,将需要摘要的网页 URL 动态传递给服务器。
- 本地运行: 此配置假设 MCP 服务器和客户端在同一台机器上运行。如果需要远程调用,需要考虑网络配置和安全性。
- mcp-agent 框架: 本项目依赖 'mcp-agent' 框架,更详细的 MCP Agent 和 Server 的概念,请参考 mcp-agent 仓库文档。
基本使用方法
-
配置 API Key: 按照 "服务器配置" 中的说明,配置 'mcp_agent.secrets.yaml' 文件,填入 OpenAI API Key。
-
运行服务: 在项目根目录下,使用 'uv run' 命令启动服务,并通过 '--url' 参数指定要摘要的网页 URL。例如:
uv run main.py --url "https://docs.cline.bot/improving-your-prompting-skills/prompting#advanced-prompting-techniques" -
查看结果: 服务运行后,会在命令行输出网页的摘要结果。
对于 MCP 客户端: MCP 客户端需要根据 "服务器配置" 中的信息,配置并连接到 'webpage_summary_server',然后通过 MCP 协议向服务器发送请求,以获取网页摘要服务。具体的客户端请求方式和协议细节,请参考 MCP 协议和 'mcp-agent' 框架文档。
信息
分类
网页与API