@cqsjjb/meter-sphere-mcp-server 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +35 -20
  2. package/mcp-config.example.json +22 -20
  3. package/mcp-server.mjs +998 -927
  4. package/package.json +5 -2
package/README.md CHANGED
@@ -28,13 +28,15 @@ npm install @cqsjjb/meter-sphere-mcp-server
28
28
  "command": "npx",
29
29
  "args": ["-y", "@cqsjjb/meter-sphere-mcp-server"],
30
30
  "env": {
31
- "PLATFORM_URL": "http://your-platform-url?organization=xxx&project=xxx&testPlanId=xxx",
32
- "X_AUTH_TOKEN": "your-x-auth-token-here",
33
- "CSRF_TOKEN": "your-csrf-token-here",
34
- "API_BASE_URL": "http://192.168.3.26:8081",
31
+ "PLATFORM_X_AUTH_TOKEN": "your-x-auth-token-here",
32
+ "PLATFORM_CSRF_TOKEN": "your-csrf-token-here",
33
+ "PLATFORM_PROJECT": "your-project-id",
34
+ "PLATFORM_ORGANIZATION": "your-organization-id",
35
+ "PLATFORM_MODULE_IDS": "[]",
35
36
  "MODEL_BASE_URL": "https://api.deepseek.com",
36
37
  "MODEL_API_KEY": "your-model-api-key-here",
37
- "MODEL_ID": "deepseek-chat"
38
+ "MODEL_ID": "deepseek-chat",
39
+ "MODEL_ANALYSIS_PROMPT": ""
38
40
  }
39
41
  }
40
42
  }
@@ -49,13 +51,15 @@ npm install @cqsjjb/meter-sphere-mcp-server
49
51
  "command": "node",
50
52
  "args": ["./node_modules/@cqsjjb/meter-sphere-mcp-server/mcp-server.mjs"],
51
53
  "env": {
52
- "PLATFORM_URL": "http://your-platform-url?organization=xxx&project=xxx&testPlanId=xxx",
53
- "X_AUTH_TOKEN": "your-x-auth-token-here",
54
- "CSRF_TOKEN": "your-csrf-token-here",
55
- "API_BASE_URL": "http://192.168.3.26:8081",
54
+ "PLATFORM_X_AUTH_TOKEN": "your-x-auth-token-here",
55
+ "PLATFORM_CSRF_TOKEN": "your-csrf-token-here",
56
+ "PLATFORM_PROJECT": "your-project-id",
57
+ "PLATFORM_ORGANIZATION": "your-organization-id",
58
+ "PLATFORM_MODULE_IDS": "[]",
56
59
  "MODEL_BASE_URL": "https://api.deepseek.com",
57
60
  "MODEL_API_KEY": "your-model-api-key-here",
58
- "MODEL_ID": "deepseek-chat"
61
+ "MODEL_ID": "deepseek-chat",
62
+ "MODEL_ANALYSIS_PROMPT": ""
59
63
  }
60
64
  }
61
65
  }
@@ -64,15 +68,26 @@ npm install @cqsjjb/meter-sphere-mcp-server
64
68
 
65
69
  ## 环境变量说明
66
70
 
67
- - `PLATFORM_URL` (必需): 测试用例平台的完整URL（包含查询参数）
68
- - `X_AUTH_TOKEN` (必需): x-auth-token认证令牌
69
- - `CSRF_TOKEN` (必需): Csrf-token认证令牌
70
- - `API_BASE_URL` (可选): API服务器的基础URL，默认值为 `http://192.168.3.26:8081`
71
- - `MODEL_BASE_URL` (可选): AI模型API的基础URL，默认值为 `https://api.deepseek.com`
72
- - `MODEL_API_KEY` (可选): AI模型API密钥，如果未配置则跳过AI分析
73
- - `MODEL_ID` (可选): AI模型ID，默认值为 `deepseek-chat`
71
+ ### PLATFORM 配置（必需）
72
+ - `PLATFORM_X_AUTH_TOKEN` (必需): x-auth-token认证令牌，用于API请求头
73
+ - `PLATFORM_CSRF_TOKEN` (必需): Csrf-token认证令牌，用于API请求头
74
+ - `PLATFORM_PROJECT` (必需): 项目ID，用于API请求头
75
+ - `PLATFORM_ORGANIZATION` (必需): 组织ID，用于API请求头
76
+ - `PLATFORM_MODULE_IDS` (可选): 模块ID数组，JSON字符串格式，如 `"[]"` 或 `"[\"id1\",\"id2\"]"`，用于列表接口的请求参数
77
+
78
+ ### MODEL 配置（可选）
79
+ - `MODEL_BASE_URL` (可选): AI模型API的基础URL，如 `https://api.deepseek.com`
80
+ - `MODEL_API_KEY` (可选): AI模型API密钥，如果未配置则跳过AI分析功能
81
+ - `MODEL_ID` (可选): AI模型ID，如 `deepseek-chat`
82
+ - `MODEL_ANALYSIS_PROMPT` (可选): AI分析提示语模板，支持 `{{PROMPT_TEXT}}` 占位符，如果未配置或为空则使用默认提示语
83
+
84
+ ### 其他配置（可选）
74
85
  - `PROGRESS_FILE_DIR` (可选): 进度文件存储目录，默认值为当前工作目录（`process.cwd()`）
75
86
 
87
+ **注意**：
88
+ - API基础URL已硬编码为 `http://192.168.3.26:8081`，无需配置
89
+ - MODEL配置为可选，不配置时核心功能（获取测试列表、详情、进度跟踪）仍可正常使用，只是不会进行AI分析
90
+
76
91
  ## 可用工具
77
92
 
78
93
  ### 1. `get_test_list` - 获取测试用例列表
@@ -94,7 +109,7 @@ npm install @cqsjjb/meter-sphere-mcp-server
94
109
 
95
110
  ### 2. `get_test_detail` - 获取测试用例详情
96
111
 
97
- 根据测试用例 ID 获取详细信息，包括测试步骤和 AI 测试提示语。会自动调用 AI 模型进行测试用例分析。
112
+ 根据测试用例 ID 获取详细信息，包括测试步骤和 AI 测试提示语。如果配置了 MODEL，会自动调用 AI 模型进行测试用例分析；如果未配置 MODEL，则只返回测试用例详情。
98
113
 
99
114
  **参数：**
100
115
  - `testCaseId` (string, 必需): 测试用例 ID
@@ -150,13 +165,13 @@ MCP 工具会自动将测试进度保存到 `test-progress.json` 文件中。进
150
165
  3. **用户配置目录**（`~/.config/meter-sphere-mcp/`）- 回退方案
151
166
 
152
167
  进度文件包含：
153
- - 测试计划ID
154
168
  - 已完成用例列表（包含用例ID、优先级、完成时间）
155
169
  - 总用例数和已完成数量
170
+ - 最后更新时间
156
171
 
157
172
  **注意**：
158
- - 如果切换了不同的测试计划（testPlanId），进度会自动重置
159
173
  - 进度文件默认保存在用户项目根目录中，不同项目有独立的进度文件
174
+ - 可以使用 `reset_test_progress` 工具重置进度
160
175
  - 建议将 `test-progress.json` 添加到 `.gitignore`，避免提交到代码仓库
161
176
 
162
177
  ## 注意事项
package/mcp-config.example.json CHANGED
@@ -1,20 +1,22 @@
1
- {
2
- "mcpServers": {
3
- "meter-sphere": {
4
- "command": "node",
5
- "args": [
6
- "./node_modules/@cqsjjb/meter-sphere-mcp-server/mcp-server.mjs"
7
- ],
8
- "env": {
9
- "PLATFORM_URL": "http://your-platform-url?organization=xxx&project=xxx&testPlanId=xxx",
10
- "X_AUTH_TOKEN": "your-x-auth-token-here",
11
- "CSRF_TOKEN": "your-csrf-token-here",
12
- "API_BASE_URL": "http://192.168.3.26:8081",
13
- "MODEL_BASE_URL": "https://api.deepseek.com",
14
- "MODEL_API_KEY": "your-model-api-key-here",
15
- "MODEL_ID": "deepseek-chat"
16
- },
17
- "description": "MeterSphere 测试用例平台 MCP 工具"
18
- }
19
- }
20
- }
1
+ {
2
+ "mcpServers": {
3
+ "meter-sphere": {
4
+ "command": "node",
5
+ "args": [
6
+ "./node_modules/@cqsjjb/meter-sphere-mcp-server/mcp-server.mjs"
7
+ ],
8
+ "env": {
9
+ "PLATFORM_X_AUTH_TOKEN": "your-x-auth-token-here",
10
+ "PLATFORM_CSRF_TOKEN": "your-csrf-token-here",
11
+ "PLATFORM_PROJECT": "your-project-id",
12
+ "PLATFORM_ORGANIZATION": "your-organization-id",
13
+ "PLATFORM_MODULE_IDS": "[]",
14
+ "MODEL_BASE_URL": "https://api.deepseek.com",
15
+ "MODEL_API_KEY": "your-model-api-key-here",
16
+ "MODEL_ID": "deepseek-chat",
17
+ "MODEL_ANALYSIS_PROMPT": ""
18
+ },
19
+ "description": "MeterSphere 测试用例平台 MCP 工具"
20
+ }
21
+ }
22
+ }