ksrk-mcp-server-client

🚀 项目运行指引

本项目为一个与 MCP 服务器和 OpenAI 的 GPT - 4 模型交互的工具，可帮助用户在特定环境下进行网络搜索、信息查询等操作。

🚀 快速开始

需求

• Python 3.13
• 列出在 pyproject.toml 中的依赖项

安装

1. 克隆仓库：

git clone <repository-url>
cd documentation

2. 创建虚拟环境并激活它：

python -m venv .venv
source .venv/bin/activate  # 在 Windows 上使用 `.venv\Scripts\activate`

3. 安装依赖项：

pip install -r requirements.txt

4. 设置环境变量： 在项目根目录中创建一个 .env 文件，内容如下：

SCRAPING_DOG_API_KEY=your_scraping_dog_api_key
OPENAI_API_KEY=your_openai_api_key

使用方法

运行客户端

1. 导航到根目录：

cd ..

2. 运行客户端：

python client.py

3. 在交互式提示符中输入您的问题。输入 quit 或 exit 以停止客户端。

💻 使用示例

基础用法

按照上述安装和运行客户端的步骤，在交互式提示符中输入简单问题，例如询问某个常见事物的信息，即可获取相应结果。

# 克隆仓库
git clone <repository-url>
cd documentation
# 创建并激活虚拟环境
python -m venv .venv
source .venv/bin/activate
# 安装依赖
pip install -r requirements.txt
# 设置环境变量（创建.env文件）
# 导航到根目录
cd ..
# 运行客户端
python client.py

高级用法

在更复杂的场景中，可利用项目提供的工具进行网络搜索、获取特定网站信息等。例如，使用 ksrk-mcp 中的工具搜索有关“ksrk”的详细信息。

# 假设在 client.py 中调用相关工具
# 这里仅为示意，实际代码需根据项目逻辑编写
from client import MCPClient

client = MCPClient()
# 调用特定工具进行操作
result = client.call_specific_tool()
print(result)

📚 详细文档

项目文件

client.py

此文件包含与 MCP 服务器和 OpenAI 的 GPT - 4 模型交互的主要客户端代码。它包括以下关键组件：

• MCPClient：一个管理与 MCP 服务器连接并提供调用可用工具方法的类。
• agent_loop：一个异步函数，用于处理用户查询并使用 LLM 和可用工具进行分析。
• main：主函数，用于设置 MCP 服务器、初始化工具，并运行交互式循环。

ksrk-mcp/ksrk-mcp-server.py

此文件包含 MCP 服务器的实现。它包括以下关键组件：

• search_web：一个使用 ScrapingDog API 进行网络搜索的异步函数。
• fetch_url：一个用于获取指定 URL 内容的异步函数。
• about_ksrk：一个 MCP 工具，用于在指定网站上搜索有关“ksrk”的详细信息。

ksrk-mcp/test-website.py

此文件包含一个使用 httpx 和 BeautifulSoup 测试网站抓取的脚本。

📄 许可证

该项目根据 MIT 许可证发布。有关详细信息，请参阅 LICENSE 文件。

致谢

• OpenAI 为提供 GPT - 4 模型。
• ScrapingDog 为网络抓取 API。
• BeautifulSoup 用于解析 HTML 和 XML 文档。
• httpx 用于 HTTP 客户端。