whistle-mcp

# Whistle MCP Server

中文 | [English](README.md)

## 项目简介

Whistle MCP Server 是一个基于 Model Context Protocol (MCP) 协议的 Whistle 代理管理工具，让 AI 助手能够直接操作和控制本地 Whistle 代理服务器。通过该工具，AI 可以帮助用户管理规则、分组、值，监控网络请求，以及重放和修改请求等，无需用户手动操作 Whistle 界面。它极大地简化了网络调试、接口测试和代理规则管理的流程，使用户能够通过自然语言与 AI 交互来完成复杂的网络代理配置任务。

## 功能特点

- **规则管理**：创建、更新、重命名、删除和启用/禁用 Whistle 规则
- **分组管理**：创建、重命名、删除分组，以及规则与分组之间的关联操作
- **值管理**：创建、更新、重命名和删除值，支持值分组管理
- **代理控制**：启用/禁用代理、HTTP/HTTPS 拦截、HTTP/2 协议等
- **请求拦截**：查看拦截的网络请求信息，支持 URL 过滤
- **请求重放**：支持重放捕获的请求，可自定义请求参数
- **多规则模式**：支持启用/禁用多规则模式

## 安装

您可以通过 npm 全局安装 Whistle MCP Server：

```bash
npm install -g whistle-mcp-tool
```

## MCP 配置

安装后，您可以在 MCP JSON 配置文件中配置 Whistle MCP：

```json
{
  "mcpServers": {
    "whistle-mcp": {
      "command": "whistle-mcp",
      "args": [
        "--host=<whistle的服务器IP地址>",
        "--port=<whistle的服务器端口号>"
      ]
    }
  }
}
```

### 配置说明

- host whistle的服务器IP地址 不配置的时候使用localhost作为默认值
- port whistle的服务器端口号 不配置的时候使用8899作为默认值

## 将 MCP JSON 配置到 AI 客户端 中

- Claude 客户端: [https://modelcontextprotocol.io/quickstart/user](https://modelcontextprotocol.io/quickstart/user)
- Raycast: 需要安装 MCP 插件
- Cursor: [https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers](https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers)

## MCP 工具说明

Whistle MCP Server 提供了以下工具，可通过 MCP 协议调用：

### 规则管理

| 工具名称 | 描述 | 功能 |
| ------- | --- | ---- |
| getRules | 获取所有规则 | 列出所有已创建的规则及其内容 |
| createRule | 创建新规则 | 新建一个指定名称的规则 |
| updateRule | 更新规则内容 | 修改指定规则的内容 |
| renameRule | 重命名规则 | 将规则重命名为新名称 |
| deleteRule | 删除规则 | 删除指定名称的规则 |
| selectRule | 启用规则 | 启用指定名称的规则 |
| unselectRule | 禁用规则 | 禁用指定名称的规则 |
| disableAllRules | 禁用所有规则 | 一键禁用所有已创建的规则 |

### 分组管理

| 工具名称 | 描述 | 功能 |
| ------- | --- | ---- |
| createGroup | 创建分组 | 新建一个指定名称的规则分组 |
| renameGroup | 重命名分组 | 将规则分组重命名为新名称 |
| deleteGroup | 删除分组 | 删除指定名称的规则分组 |
| moveRuleToGroup | 移动规则到分组 | 将指定规则移动到特定分组中 |
| moveRuleOutOfGroup | 移出规则 | 将规则从分组中移出到顶层 |

### 值管理

| 工具名称 | 描述 | 功能 |
| ------- | --- | ---- |
| getAllValues | 获取所有值 | 列出所有已创建的值和值分组 |
| createValue | 创建新值 | 新建一个指定名称的值 |
| updateValue | 更新值内容 | 修改指定值的内容 |
| renameValue | 重命名值 | 将值重命名为新名称 |
| deleteValue | 删除值 | 删除指定名称的值 |
| createValueGroup | 创建值分组 | 新建一个指定名称的值分组 |
| renameValueGroup | 重命名值分组 | 将值分组重命名为新名称 |
| deleteValueGroup | 删除值分组 | 删除指定名称的值分组 |
| moveValueToGroup | 移动值到分组 | 将指定值移动到特定分组中 |
| moveValueOutOfGroup | 移出值 | 将值从分组中移出到顶层 |

### 代理控制

| 工具名称 | 描述 | 功能 |
| ------- | --- | ---- |
| getStatus | 获取服务器状态 | 获取 Whistle 服务器的当前状态信息 |
| toggleProxy | 启用/禁用代理 | 切换 Whistle 代理的启用状态 |
| toggleHttpsInterception | 启用/禁用HTTPS拦截 | 切换 HTTPS 请求拦截的启用状态 |
| toggleHttp2 | 启用/禁用HTTP2 | 切换 HTTP/2 协议支持的启用状态 |
| toggleMultiRuleMode | 启用/禁用多规则模式 | 切换是否允许同时启用多个规则 |

### 请求管理

| 工具名称 | 描述 | 功能 |
| ------- | --- | ---- |
| getInterceptInfo | 获取拦截信息 | 获取 Whistle 拦截的网络请求信息，支持过滤 |
| replayRequest | 重放请求 | 重新发送指定的网络请求，可自定义参数 |

## 联系方式

- 邮箱: [gz7gugu@qq.com](mailto:gz7gugu@qq.com)
- 博客: [https://7gugu.com](https://7gugu.com)