使用说明

项目简介

Whistle MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当连接 AI 助手和本地 Whistle 代理服务器的桥梁。通过这个工具,用户可以使用自然语言与 AI 助手交互,从而间接控制和管理 Whistle 代理服务器,例如配置代理规则、管理分组、查看网络请求等,无需手动操作 Whistle 界面,极大地提升了网络调试、API 测试和代理规则管理的效率。

主要功能点

  • 规则管理: 支持规则的创建、更新、重命名、删除以及启用/禁用,方便用户通过 AI 助手管理 Whistle 代理规则。
  • 分组管理: 支持规则分组的创建、重命名和删除,以及规则在分组间的移动,帮助用户更有序地组织和管理规则。
  • 值管理: 支持值的创建、更新、重命名和删除,以及值分组的管理,便于用户管理 Whistle 的值配置。
  • 代理控制: 支持启用/禁用代理、HTTP/HTTPS 拦截、HTTP/2 协议以及多规则模式等 Whistle 核心功能的控制。
  • 请求拦截信息: 允许用户通过 AI 助手查询 Whistle 拦截的网络请求信息,并支持 URL 过滤,方便问题排查。
  • 请求重放: 支持重放捕获的网络请求,并允许自定义请求参数,辅助 API 调试。

安装步骤

  1. 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 全局安装 whistle-mcp-tool: 打开终端或命令提示符,运行以下命令全局安装 'whistle-mcp-tool':
    npm install -g whistle-mcp-tool

服务器配置

为了让 MCP 客户端(如 Claude、Cursor、Raycast 等)连接到 Whistle MCP Server,您需要在 MCP 客户端的配置文件中添加以下服务器配置信息。请注意,您需要将 '<whistle服务器IP地址>' 和 '<whistle服务器端口号>' 替换为您的 Whistle 代理服务器的实际 IP 地址和端口号。如果 Whistle 服务器运行在本地,默认 IP 地址为 'localhost',默认端口号为 '8899'。

{
  "mcpServers": {
    "whistle-mcp": {
      "command": "whistle-mcp-tool",
      "args": [
        "--host=<whistle服务器IP地址>",  // Whistle 服务器的 IP 地址,默认为 localhost
        "--port=<whistle服务器端口号>"   // Whistle 服务器的端口号,默认为 8899
      ]
    }
  }
}

基本使用方法

  1. 启动 Whistle MCP Server: 安装完成后,MCP 服务器会自动在后台运行,无需手动启动。当 MCP 客户端发起连接请求时,服务器会被唤醒。
  2. 配置 MCP 客户端: 根据您使用的 MCP 客户端(如 Claude、Cursor、Raycast)的文档,配置上述服务器配置信息。
  3. 通过 AI 助手操作 Whistle: 配置完成后,您就可以通过与 AI 助手对话,使用自然语言来管理 Whistle 代理服务器了。例如,您可以对 AI 助手说:
    • “创建一个名为 'test-rule' 的新规则”
    • “禁用所有代理规则”
    • “查看最近拦截的关于 'example.com' 的请求”
    • “将规则 'my-rule' 移动到分组 'group1'”

AI 助手会将您的自然语言指令转换为 MCP 协议请求发送给 Whistle MCP Server,服务器会调用 Whistle 代理服务器的 API 完成相应的操作,并将结果返回给 AI 助手。

信息

分类

开发者工具