使用说明

项目简介

本项目实现了一个基于 Model Context Protocol (MCP) 的服务器，它充当 LLM 客户端和 Test Management System (TMS) 之间的桥梁。通过该 MCP 服务器，LLM 客户端可以访问 TMS 中存储的测试用例和相关文档，并利用提供的工具根据 TMS 数据辅助生成测试代码。

主要功能点

资源访问:
- 提供 'testing-docs' 资源，允许访问测试平台文档。
- 提供 'testcase' 资源，支持通过 'testcase://projects/{project}/test-cases/{id}' 格式的 URI 获取指定项目和 ID 的测试用例内容。
工具调用:
- 'get_testcase' 工具：根据 TMS 路径获取测试用例的详细内容。
- 'generate_test_from_tms' 工具：根据 TMS 测试用例 URL 和文件路径，生成符合测试用例描述的测试代码片段。
- 'create_test' 工具：根据文件路径生成用于指导 LLM 编写测试代码的 Prompt 指令。
Prompt 模板:
- 'test_generation_instruction' Prompt：为 LLM 提供生成测试代码的指令，指示 LLM 根据指定文件和相关文档编写测试。
传输协议:
- 使用 Stdio (标准输入输出) 作为 MCP 服务器的传输协议。

安装步骤

克隆仓库:

git clone https://github.com/misbiheyv/testing-mcp-server.git
cd testing-mcp-server

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

MCP 客户端 (如 Cline 或 Continue) 需要配置 MCP 服务器的启动命令和参数。以下是 JSON 格式的配置信息示例：

用于 Cline (VSCode):

{
  "mcpServers": {
    "tms-adapter": {
      "command": "/path/to/your/node",  // 【请替换为你的 Node.js 可执行文件路径，例如：/usr/local/bin/node 或使用 which node 命令查找】
      "args": [
        "/path/to/testing-mcp-server/build/index.js"  // 【请替换为你的 testing-mcp-server 项目 build 目录下的 index.js 路径，例如：/Users/your_user/testing-mcp-server/build/index.js】
      ],
      "disabled": false,
      "env": {
        "TMS_TOKEN": ""  // 【请配置 TMS Token 环境变量，如果需要访问 TMS 资源，请替换为你的 TMS API Token】
      }
    }
  }
}

用于 Continue (VSCode 和 WS):

{
  "experimental": {
    "modelContextProtocolServers": [
      {
        "transport": {
          "type": "stdio",
          "command": "/path/to/your/node",  // 【请替换为你的 Node.js 可执行文件路径，例如：/usr/local/bin/node 或使用 which node 命令查找】
          "args": [
            "/path/to/testing-mcp-server/build/index.js"  // 【请替换为你的 testing-mcp-server 项目 build 目录下的 index.js 路径，例如：/Users/your_user/testing-mcp-server/build/index.js】
          ]
        }
      }
    ]
  },
}

注意:

请根据你的 Node.js 安装路径和项目实际 build 路径修改 'command' 和 'args' 配置。
如果需要访问 TMS 资源，请确保设置 'TMS_TOKEN' 环境变量。

基本使用方法

启动 MCP 服务器 (通过 MCP 客户端，如 Cline 或 Continue 启动)。
在 MCP 客户端中，可以使用以下功能：
- 访问测试文档: 通过资源 URI 'docs://testing-docs' 获取测试平台文档内容。
- 获取测试用例: 通过资源 URI 'testcase://projects/{project}/test-cases/{id}' 获取指定项目和 ID 的测试用例内容 (例如: 'testcase://projects/your-project/test-cases/123').
- 调用工具:
  - 使用 'get_testcase' 工具，并传入 TMS 路径参数 (例如: 'projects/your-project/testcases/123') 获取测试用例内容。
  - 使用 'generate_test_from_tms' 工具，并传入 'file' (目标文件路径) 和 'url' (TMS 测试用例 URL) 参数，生成测试代码。
  - 使用 'create_test' 工具，并传入 'testFilePath' (目标文件路径) 参数，获取测试代码生成指令 Prompt。

示例: 在 LLM 客户端中，可以指示 AI Agent 调用 'generate_test_from_tms' 工具，提供当前需要生成测试代码的文件路径和 TMS 中对应测试用例的 URL，从而辅助生成符合 TMS 规范的测试代码。

关键词