testcase-generator-mcp 0.1.0__tar.gz

testcase_generator_mcp-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

testcase_generator_mcp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 EmptyRabbit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

testcase_generator_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: testcase-generator-mcp
+Version: 0.1.0
+Summary: Testcase Generator MCP Server for generating and managing test cases
+Author-email: EmptyRabbit <qiuzhouxin@163.com>
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: build>=1.4.0
+Requires-Dist: mcp[cli]>=1.10.1
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: typer>=0.16.0
+Description-Content-Type: text/markdown
+
+# testcase-generator-mcp
+
+Testcase Generator MCP Server，用于生成与管理测试用例。
+
+## 目录结构（参考 excel-mcp-server）
+
+```
+testcase-generator-mcp/
+├── pyproject.toml
+├── README.md
+└── src/
+    └── testcase_generator_mcp/
+        ├── __init__.py
+        ├── __main__.py      # CLI 入口：sse / stdio / streamable_http
+        ├── exceptions.py    # 异常类型
+        └── server.py        # FastMCP 服务与工具定义
+```
+
+## 安装与运行
+
+```bash
+# 安装依赖（含 mcp、fastmcp、typer）
+pip install -e .
+
+# 以 stdio 方式启动（常用于 Cursor/IDE MCP 配置）
+testcase-generator-mcp stdio
+
+# 以 SSE 方式启动
+testcase-generator-mcp sse
+
+# 以 streamable HTTP 方式启动
+testcase-generator-mcp streamable_http
+```
+
+或使用模块方式：
+
+```bash
+python -m testcase_generator_mcp stdio
+```
+
+## 工具
+
+- **generate_test_cases**：根据需求描述生成测试用例（当前为占位实现）。
+- **get_server_info**：返回服务名称与版本。
+
+日志文件默认写在项目根目录：`testcase-generator-mcp.log`。

testcase_generator_mcp-0.1.0/README.md

@@ -0,0 +1,46 @@
+# testcase-generator-mcp
+
+Testcase Generator MCP Server，用于生成与管理测试用例。
+
+## 目录结构（参考 excel-mcp-server）
+
+```
+testcase-generator-mcp/
+├── pyproject.toml
+├── README.md
+└── src/
+    └── testcase_generator_mcp/
+        ├── __init__.py
+        ├── __main__.py      # CLI 入口：sse / stdio / streamable_http
+        ├── exceptions.py    # 异常类型
+        └── server.py        # FastMCP 服务与工具定义
+```
+
+## 安装与运行
+
+```bash
+# 安装依赖（含 mcp、fastmcp、typer）
+pip install -e .
+
+# 以 stdio 方式启动（常用于 Cursor/IDE MCP 配置）
+testcase-generator-mcp stdio
+
+# 以 SSE 方式启动
+testcase-generator-mcp sse
+
+# 以 streamable HTTP 方式启动
+testcase-generator-mcp streamable_http
+```
+
+或使用模块方式：
+
+```bash
+python -m testcase_generator_mcp stdio
+```
+
+## 工具
+
+- **generate_test_cases**：根据需求描述生成测试用例（当前为占位实现）。
+- **get_server_info**：返回服务名称与版本。
+
+日志文件默认写在项目根目录：`testcase-generator-mcp.log`。

testcase_generator_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "testcase-generator-mcp"
+version = "0.1.0"
+description = "Testcase Generator MCP Server for generating and managing test cases"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "mcp[cli]>=1.10.1",
+    "typer>=0.16.0",
+    "pydantic>=2.12.5",
+    "build>=1.4.0",
+]
+[[project.authors]]
+name = "EmptyRabbit"
+email = "qiuzhouxin@163.com"
+
+[project.scripts]
+testcase-generator-mcp = "testcase_generator_mcp.__main__:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/testcase_generator_mcp"]
+
+[tool.hatch.build]
+packages = ["src/testcase_generator_mcp"]

testcase_generator_mcp-0.1.0/testcase_generator_mcp/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

testcase_generator_mcp-0.1.0/testcase_generator_mcp/__main__.py

@@ -0,0 +1,54 @@
+import typer
+
+from .server import run_sse, run_stdio, run_streamable_http
+
+app = typer.Typer(help="Testcase Generator MCP Server")
+
+
+@app.command()
+def sse():
+    """Start Testcase Generator MCP Server with SSE."""
+    try:
+        run_sse()
+    except KeyboardInterrupt:
+        print("\nShutting down server...")
+    except Exception as e:
+        print(f"\nError: {e}")
+        import traceback
+        traceback.print_exc()
+    finally:
+        print("Service stopped.")
+
+
+@app.command()
+def streamable_http():
+    """Start Testcase Generator MCP Server with streamable HTTP."""
+    try:
+        run_streamable_http()
+    except KeyboardInterrupt:
+        print("\nShutting down server...")
+    except Exception as e:
+        print(f"\nError: {e}")
+        import traceback
+        traceback.print_exc()
+    finally:
+        print("Service stopped.")
+
+
+@app.command()
+def stdio():
+    """Start Testcase Generator MCP Server with stdio."""
+    try:
+        run_stdio()
+    except KeyboardInterrupt:
+        print("\nShutting down server...")
+    except Exception as e:
+        print(f"\nError: {e}")
+        import traceback
+        traceback.print_exc()
+    finally:
+        print("Service stopped.")
+
+
+if __name__ == "__main__":
+    app()

testcase_generator_mcp-0.1.0/testcase_generator_mcp/prompt/generate_test_case.md

@@ -0,0 +1,208 @@
+## 目标
+
+你是一个经验丰富的测试人员，现在需要根据提供的上下文信息，理解需求的逻辑，并根据要求完成核心任务
+
+## 上下文信息
+
+用户在对话中提供以下信息：
+
+- 需求文档：业务需求和功能说明
+- 技术文档：技术实现方案和接口文档
+- 设计稿：UI设计和交互流程
+- 历史文档：相关的历史需求和测试用例
+- 其他资料：补充说明和参考资料
+
+## 核心任务
+
+所有子任务：环境检查，规划需求模块，规划需求追溯矩阵，生成 .md 测试用例文件，生成 .xmind 测试用例文件，创建TestHub测试计划
+
+**重要：你的任务是必须严格按照以下步骤顺序执行子任务，不得跳过任何步骤。若需要用户回复，严禁在用户回复前执行任何后续步骤。**
+
+**注意：执行过程中若没有明确指定写入文件，请不要直接写入文件。**
+
+1. 第一步（必须执行）：开始阶段 - 环境检查
+2. 第二步（必须执行）：规划阶段 - 规划需求模块
+3. 第三步（必须执行）：规划阶段 - 规划需求追溯矩阵
+4. 第四步（必须执行）：生成用例阶段 - 生成 .md 测试用例文件
+5. 第五步（条件执行）：生成用例阶段 - 生成 .xmind 测试用例文件
+6. 第六步（条件执行）：生成用例阶段 - 创建TestHub测试计划
+
+## 子任务内容
+
+### 1. 开始阶段 - 环境检查
+
+- 步骤1：检查当前环境是否配置了 MCP： `feishu2md`
+- 步骤2：当需要生成 .xmind 文件时（见第五步条件），检查当前环境是否配置了 MCP： `xmind-generator-mcp`
+- 步骤3：如果存在未配置的 MCP，请提示用户以下内容，并**等待用户回复后，再继续后续步骤**。输出内容：
+
+```markdown
+**检测到环境中未配置MCP：<缺失的具体 MCP 名称>，请确认后，回复：**
+
+1. **继续**
+2. **终止**
+```
+
+- 步骤4：无任何 MCP 缺失，请输出内容：**环境检查通过**
+
+### 2. 规划阶段 - 规划需求模块
+
+- 步骤1：如果用户提供了链接，优先调用工具读取内容，分析上下文，拆解功能架构，规划需要测试的模块。
+    - **仅规划模块名称**，不要包含具体的测试点或步骤
+    - 所有模块的划分必须遵循 MECE 原则，相互独立，完全穷尽
+    - 结构支持 2-4 个层级，根据需求复杂度**自主决定层级深度**
+    - **必须体现层级归属关系**：一个父模块应包含其下所有的子模块（一对多），在表格中通过多行展示
+- 步骤2：严格按以下格式输出步骤1的结果。**输出后立即停止，不得继续执行任何后续步骤，必须等待用户明确回复"继续"后，才能进入后续步骤
+  **。请输出内容：
+
+```markdown
+**模块规划结果：**
+| 模块ID | 一级模块 | 二级模块 | 三级模块（可选)） | 四级模块（可选） |
+| :--- | :--- | :--- | :--- | :--- |
+| 1 | `订单管理` | `列表页` | `筛选功能` | `状态筛选` |
+| 2 | `订单管理` | `列表页` | `筛选功能` | `时间筛选` |
+| 3 | `订单管理` | `列表页` | `列表操作` | / |
+| 4 | `订单管理` | `详情页` | / | / |
+| 5 | `支付模块` | `支付流程` | `微信支付` | / |
+
+**请对以上结果进行确认，回复：**
+
+1. **继续**
+2. **具体的修改建议**：例如"去除三级模块A，四级模块B名称变更为XX，新增一级模块A-二级模块B"
+```
+
+### 3. 规划阶段 - 规划需求追溯矩阵
+
+- 步骤1：根据模块规划结果，梳理所有模块的需求描述，在模块规划结果中补充该模块相关的需求描述，需求ID，并提炼测试点
+    - 需求ID必须是唯一的，由R+4位数字组成
+    - 需求描述必须引用上下文中的**原始内容**
+    - 需求描述若超过15字（英文字母计算为0.5个字），请将多余的文字处理成`...`（`...`必须在中间），例如：`原始内容前半段...原始内容后半段`
+    - 测试点：基于需求描述提炼的核心测试逻辑，简练概括需要验证的功能点
+    - 模块、需求描述和测试点的内容，需要用反引号``包裹
+- 步骤2：检查是否有遗漏的需求内容，确保需求内容已被完整覆盖
+- 步骤3：严格按以下格式，按各个一级模块，输出步骤1、步骤2的结果。*
+  *输出后立即停止，不得继续执行任何后续步骤，必须等待用户明确回复"继续"后，才能进入后续步骤**。请输出内容：
+
+```markdown
+**需求追溯矩阵规划结果**
+
+**【一级模块】`订单管理`**
+| 需求ID | 需求描述 | 测试点 | 二级模块 | 三级模块（可选） | 四级模块（可选） |
+| :--- | :--- | :--- | :--- | :--- | :--- |
+| R0001 | `支持按订单状态筛选` | `验证订单列表支持按状态进行筛选` | `列表页` | `筛选功能` | `状态筛选` |
+| R0002 | `状态筛选枚举值展示A,B,C` | `验证状态筛选下拉框包含A,B,C三个选项` | `列表页` | `筛选功能` | `状态筛选` |
+| R0003 | `支持按时间范围筛选...筛选出结果` | `验证支持按时间范围筛选订单，且结果准确` | `列表页` | `筛选功能` |
+`时间筛选` |
+| R0004 | `支持查看详情、取消` | `验证列表项支持查看详情及取消订单操作` | `列表页` | `列表操作` | / |
+| R0005 | `展示订单详细信息` | `验证订单详情页信息展示完整且准确` | `详情页` | / | / |
+
+**【一级模块】：`支付模块`**
+| 需求ID | 需求描述 | 测试点 | 二级模块 | 三级模块（可选） | 四级模块（可选） |
+| :--- | :--- | :--- | :--- | :--- | :--- |
+| R0006 | `支持微信支付` | `验证支持微信支付方式且流程通畅` | `支付流程` | `微信支付` | / |
+
+**请对以上结果进行确认，回复：**
+
+1. **继续**
+2. **具体的修改建议**：例如"R0002测试点理解错误，应该为XXX"
+```
+
+### 4. 生成用例阶段 - 生成 .md 测试用例文件
+
+- 步骤1：了解下方附录中的 `用例设计原则` 和 `用例优先级定义` 的内容。
+- 步骤2：根据 `用例设计原则` 和 `用例优先级定义` 的内容，结合上下文信息和需求追溯矩阵，设计和生成测试用例，并按照以下格式，写入.md文件
+    - Markdown 格式
+      ```markdown
+      # 需求名
+           
+      ## 一级模块名
+    
+      ### 二级模块名
+           
+      #### 三级模块名（可选）
+           
+      ##### 四级模块名（可选）   
+      - 【P0】【用例ID】测试用例描述 # 无序列表，标明优先级
+        - 步骤1：操作步骤描述 # 子项，缩进4空格
+        - 步骤2：操作步骤描述
+          - 预期结果1：验证内容的描述
+          - 预期结果2：验证内容的描述
+        - 步骤3：操作步骤描述
+          - 预期结果3：验证内容描述 # 只有1个预期结果，也需要有编号
+      ```
+    - Markdown 格式说明
+      ```markdown
+      - 使用多个 `#` 表示模块层级，最多5层，即最多为 `#####`，其中第 1 层为需求名，第 2–5 层对应一级到四级模块
+      - 用例描述前标注优先级：`【P0】`、`【P1】`、`【P2】`、`【P3】`
+      - 用例ID为 TC+4位数字，例如：TC0001
+      - 步骤和结果交替排列，逻辑清晰
+      - 子项使用4个空格缩进
+      ```
+- 步骤3：检查生成的用例中是否存在重复或可合并的步骤、用例，若有则进行去重或合并
+- 步骤4：在生成的需求追溯矩阵中新插入第一列：用例ID，将生成的用例ID，找到关联的需求后，回填到上述已输出的需求追溯矩阵中，然后重新输出需求追溯矩阵
+    - 注意：需求追溯矩阵不要写入.md文件中
+
+### 5. 生成用例阶段 - 生成 .xmind 测试用例文件
+
+- 步骤1：`is_need_xmind: {is_need_xmind}`当`is_need_xmind`为True时，调用`markdown_to_xmind`工具生成.xmind文件
+
+### 6. 生成用例阶段 - 创建TestHub测试计划
+
+- 步骤1： `idev_card_id: {idev_card_id}`当`idev_card_id`有值时，需要创建TestHub测试计划，具体步骤为：
+    - 子步骤1：根据需求上下文信息和测试用例场景，判断最有可能归属的模块：({all_module_names})，输出判断结果："
+      判断所属模块为：[模块名]"
+    - 子步骤2：调用`markdown_to_testhub_plan`工具，创建TestHub测试计划
+
+## 附录
+
+### 用例设计原则
+
+单一性
+
+- 一个用例验证一种场景，避免一个用例验证多个功能点
+- 每个测试用例应聚焦于特定的功能或业务规则
+- 确保测试结果的唯一性和可追溯性
+
+独立性
+
+- 尽可能减少用例之间的依赖，每个用例可以独立执行
+- 避免用例间的数据依赖和状态依赖
+- 每个用例应具备完整的预置条件和清理机制
+
+可重复性
+
+- 相同的步骤和操作应该有相同的预期结果
+- 测试用例应具备稳定的执行环境要求
+- 确保测试结果的一致性和可重现性
+
+正向 & 逆向验证
+
+- 包含正常流程和异常流程的完整验证
+- 覆盖成功场景和失败场景
+- 验证系统的容错能力和错误处理机制
+
+边界值验证
+
+- 对关键参数进行边界值测试
+- 包含最小值、最大值、临界值测试
+- 验证系统在边界条件下的行为
+
+多场景覆盖
+
+- 覆盖不同用户角色、不同数据状态、不同业务场景
+- 包含各种可能的用户操作路径
+- 验证系统在不同环境下的表现
+
+模块化设计
+
+- 按功能模块组织测试用例，提高可维护性
+- 保持用例结构的清晰性和一致性
+- 便于用例的复用和扩展
+
+### 用例优先级定义
+
+| 优先级 | 名称                         | 描述                                        | 典型场景                                     |
+|:----|:---------------------------|:------------------------------------------|:-----------------------------------------|
+| P0  | 最高 (**Blocker/Immediate**) | **必须执行，阻塞流程**                             | **阻塞性缺陷或核心主干场景**，必须立即执行，否则测试无法进行或产品无法发布。 |
+| P1  | 高 (**High**)               | **必须优先执行**。覆盖核心功能、高频使用路径、严重故障点、安全隐患、主干流程。 | **核心业务逻辑**，eg：用户登录、支付流程等可导致系统崩溃的用例。      |
+| P2  | 中 (**Medium**)             | **重要，但次于P1**。覆盖主要功能、常用场景、重要业务规则、主要错误处理。   | **主要功能模块的非核心路径，重要的非主干流程**，eg：部分查询功能。     |
+| P3  | 低 (**Low**)                | **可以延后执行**。覆盖次要功能、边缘场景、用户体验优化点、低频使用路径。    | **界面文案显示、非关键的错误提示、辅助性功能、极端边界值、兼容性测试等等**  |

testcase_generator_mcp-0.1.0/testcase_generator_mcp/server.py

@@ -0,0 +1,93 @@
+import logging
+import os
+from typing import Annotated
+
+from mcp.server.fastmcp import FastMCP
+from mcp.types import ToolAnnotations
+from pydantic import Field
+
+from testcase_generator_mcp.tool import generate_test_case_tool
+
+ROOT_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+LOG_FILE = os.path.join(ROOT_DIR, "testcase-generator-mcp.log")
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    handlers=[logging.FileHandler(LOG_FILE)],
+)
+logger = logging.getLogger("testcase-generator-mcp")
+
+mcp = FastMCP(
+    "testcase-generator-mcp",
+    host=os.environ.get("FASTMCP_HOST", "0.0.0.0"),
+    port=int(os.environ.get("FASTMCP_PORT", "8018")),
+    instructions="Testcase Generator MCP Server for generating and managing test cases",
+)
+
+
+@mcp.tool(
+    annotations=ToolAnnotations(
+        title="生成测试用例",
+        readOnlyHint=False,
+    ),
+)
+def generate_test_case(
+        is_need_xmind: Annotated[bool, Field(description="是否需要生成Xmind思维导图文件，默认为False")] = False,
+) -> str:
+    """
+    根据用户提供的需求文档、技术文档、设计稿等上下文信息，生成Markdown格式的测试用例
+
+    必须优先调用的场景（按优先级排序）：
+    1. 用户说"生成测试用例"、"设计测试用例"、"创建测试用例"
+    2. 用户说"保存为xmind测试用例"、"生成思维导图测试用例"、"生成xmind测试用例"
+    3. 任何涉及测试用例生成的请求
+
+    参数说明：
+    - is_need_xmind: 仅在用户明确提及"xmind"、"思维导图"等关键词时设置为True，否则必须保持默认值False
+
+    关键提醒：
+    - 当用户明确要求生成测试用例时，必须调用此工具
+    - is_need_xmind参数必须严格按照用户明确要求思维导图来决定，不能随意设置为True
+    """
+    prompt_content = generate_test_case_tool(is_need_xmind)
+    return prompt_content
+
+
+def run_sse():
+    try:
+        logger.info("Starting Testcase Generator MCP server (SSE)")
+        mcp.run(transport="sse")
+    except KeyboardInterrupt:
+        logger.info("Server stopped by user")
+    except Exception as e:
+        logger.error(f"Server failed: {e}")
+        raise
+    finally:
+        logger.info("Server shutdown complete")
+
+
+def run_streamable_http():
+    try:
+        logger.info("Starting Testcase Generator MCP server (streamable HTTP)")
+        mcp.run(transport="streamable-http")
+    except KeyboardInterrupt:
+        logger.info("Server stopped by user")
+    except Exception as e:
+        logger.error(f"Server failed: {e}")
+        raise
+    finally:
+        logger.info("Server shutdown complete")
+
+
+def run_stdio():
+    try:
+        logger.info("Starting Testcase Generator MCP server (stdio)")
+        mcp.run(transport="stdio")
+    except KeyboardInterrupt:
+        logger.info("Server stopped by user")
+    except Exception as e:
+        logger.error(f"Server failed: {e}")
+        raise
+    finally:
+        logger.info("Server shutdown complete")

testcase_generator_mcp-0.1.0/testcase_generator_mcp/tool.py

@@ -0,0 +1,22 @@
+import os
+
+
+def generate_test_case_tool(is_need_xmind: bool = False) -> str:
+    """Load and return the prompt template for generating test cases.
+
+    Reads the template from prompt/generate_test_case.md under the same package
+    directory and replaces the placeholder {is_need_xmind} with the given value.
+
+    Args:
+        is_need_xmind: Whether to generate XMind mind map format. Defaults to False.
+
+    Returns:
+        The prompt template string with placeholders substituted.
+    """
+    # Resolve path to prompt template file relative to this module
+    base_dir = os.path.dirname(os.path.abspath(__file__))
+    file_path = os.path.join(base_dir, "prompt", "generate_test_case.md")
+    with open(file_path, 'r', encoding='utf-8') as file:
+        content = file.read()
+    content = content.replace("{is_need_xmind}", str(is_need_xmind))
+    return content