Tox Testing

🚀 Tox 测试 MCP 服务器

本项目是一个基于 Model Context Protocol (MCP) 的测试服务器，它能在 Python 项目中执行 tox 命令以运行 pytest 测试。借助 MCP，该服务器为运行和管理 Python 测试提供了便捷途径。

🚀 快速开始

本服务器提供了一个工具 run_tox_tests，可在不同模式下运行测试。例如，若要运行所有测试，可使用如下参数：

{
  "mode": "all"
}

✨ 主要特性

工具

• run_tox_tests - 执行 tox 测试命令，支持多种模式和选项
  • 支持的执行模式：
    • all: 运行所有测试或指定组中的测试
    • file: 运行特定文件中的测试
    • case: 运行特定的测试用例
    • directory: 运行指定目录中的所有测试
  • 支持的测试组：
    • clients: 客户端相关测试
    • api: API 端点测试
    • auth: 认证测试
    • uploads: 上传功能测试
    • routes: 路由处理程序测试

📦 安装指南

开发环境搭建

安装依赖项：

npm install

构建服务器：

npm run build

开发时自动重建：

npm run watch

在 VSCode 中使用

要在 VSCode 中使用，请将服务器配置添加到 MCP 设置文件中，路径为： ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

{
  "mcpServers": {
    "tox-testing": {
      "command": "node",
      "args": ["/path/to/tox-testing/build/index.js"],
      "env": {
        "TOX_APP_DIR": "/path/to/your/python/project",
        "TOX_TIMEOUT": "600"
      }
    }
  }
}

配置选项

• env.TOX_TIMEOUT: (可选) 测试执行的最大等待时间，单位为秒。如果测试运行时间超过此超时，则会终止，默认值为 600 秒（10 分钟）
• env.TOX_APP_DIR: (必需) 包含 tox.ini 文件的目录。在此目录中执行 tox 命令。路径应指向 Python 项目的根目录，其中包含 tox.ini 文件

⚠️ 重要提示

超时设置特别重要，它可用于防止测试进程挂起、管理长时间运行的集成测试以及确保 CI/CD 管道不会卡住。

💻 使用示例

基础用法

服务器提供了一个工具 run_tox_tests，以下是不同使用模式的示例：

运行所有测试

{
  "mode": "all"
}

运行指定组中的测试

{
  "mode": "all",
  "group": "api"
}

运行特定文件中的测试

{
  "mode": "file",
  "testFile": "tests/test_api.py"
}

运行特定的测试用例

{
  "mode": "case",
  // 这里原文档未完整给出，保持原样
}