mcp-sentinel-qa 2.0.1 → 2.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.0.3 — 2026-11-03
4
+
5
+ ### Complete test-case fields
6
+
7
+ - Support all test-case form fields through MCP creation and partial updates,
8
+ including tags, objectives, preconditions, estimated time and assignee.
9
+ - Create and edit both Gherkin and structured-step cases, including step ordering.
10
+ - Return saved metadata in lists and complete content, including steps, in details.
11
+ - Validate assigned users against the API key's workspace.
12
+
13
+ Version 2.0.3 expands the existing test-case tools without changing their names.
14
+
15
+ ## 2.0.2 — 2026-10-29
16
+
17
+ ### Multi-level functionality hierarchy
18
+
19
+ - Update tool schemas and guidance to support functionality trees at any depth.
20
+ - Allow any same-project functionality as a parent; Sentinel validates scope and
21
+ prevents self-parenting and cycles.
22
+ - Clarify that moving a node keeps its descendant subtree and test cases attached,
23
+ while deleting a node promotes direct children and preserves deeper descendants.
24
+ - Describe the paginated list as flat rows linked by `parent_id`.
25
+
26
+ Version 2.0.2 aligns the MCP guidance with the multi-level hierarchy deployed in
27
+ Sentinel production. It preserves the thirteen tool names and argument shapes.
28
+
3
29
  ## 2.0.1 — 2026-10-29
4
30
 
5
31
  ### Functionality management
package/README.md CHANGED
@@ -27,7 +27,7 @@ Add the following server entry to your MCP client's configuration:
27
27
  "mcpServers": {
28
28
  "sentinel": {
29
29
  "command": "pnpm",
30
- "args": ["dlx", "mcp-sentinel-qa@2.0.1"],
30
+ "args": ["dlx", "mcp-sentinel-qa@2.0.3"],
31
31
  "env": {
32
32
  "SENTINEL_API_KEY": "YOUR_SENTINEL_API_KEY"
33
33
  }
@@ -43,44 +43,56 @@ secret storage or environment-variable references, use those instead.
43
43
  For a manual launch, provide the key through your environment and run:
44
44
 
45
45
  ```sh
46
- pnpm dlx mcp-sentinel-qa@2.0.1
46
+ pnpm dlx mcp-sentinel-qa@2.0.3
47
47
  ```
48
48
 
49
49
  The process waits for MCP messages on stdin; it is not an interactive terminal UI
50
50
  or an HTTP server. The API endpoint is currently fixed to
51
51
  `https://sentinel-qa.vercel.app`; `SENTINEL_API_URL` is not supported.
52
52
 
53
- ## Tools in 2.0.1
53
+ ## Tools in 2.0.3
54
54
 
55
55
  The package provides thirteen tools:
56
56
 
57
57
  | Tool | Purpose |
58
58
  | --- | --- |
59
59
  | `sentinel_list_projects` | List projects available to the API key. Start here to obtain project IDs. |
60
- | `sentinel_list_functionalities` | List project functionalities with pagination and parent details. |
61
- | `sentinel_create_functionality` | Create a root or child functionality. |
60
+ | `sentinel_list_functionalities` | List flat, paginated functionality records with each node's immediate parent. |
61
+ | `sentinel_create_functionality` | Create a root or nested functionality at any depth. |
62
62
  | `sentinel_get_functionality` | Retrieve a functionality's details, project and parent. |
63
63
  | `sentinel_update_functionality` | Partially edit its name, description, color, status or parent. |
64
- | `sentinel_move_functionality` | Move a functionality under another root or promote it to a root. |
65
- | `sentinel_delete_functionality` | Delete a functionality while preserving its cases and children. |
64
+ | `sentinel_move_functionality` | Move a functionality branch under any same-project node or promote it to a root. |
65
+ | `sentinel_delete_functionality` | Delete a functionality while preserving cases and descendant hierarchy. |
66
66
  | `sentinel_move_functionality_test_cases` | Atomically transfer selected test cases to another functionality. |
67
67
  | `sentinel_list_test_cases` | Search and paginate test cases, with project, functionality, priority, status and type filters. |
68
68
  | `sentinel_get_test_case` | Retrieve a test case by UUID. |
69
- | `sentinel_create_test_case` | Create a test case with Gherkin, priority, platforms and automation details. |
70
- | `sentinel_update_test_case` | Update only the fields supplied for an existing test case. |
69
+ | `sentinel_create_test_case` | Create a Gherkin or structured-step test case with all Sentinel fields, including tags. |
70
+ | `sentinel_update_test_case` | Partially update all test-case fields, including tags, Gherkin and structured steps. |
71
71
  | `sentinel_delete_test_case` | Permanently delete a test case by UUID. |
72
72
 
73
73
  Tool schemas expose required fields and allowed values. Test-case lists support
74
74
  `page` and `page_size` (maximum 100); functionality lists use the same pagination
75
75
  with a default page size of 20.
76
76
 
77
- Functionalities support a two-level root/child hierarchy. Parents must be roots
78
- in the same project. A functionality with children cannot become a child, and
79
- self-parenting or cycles are rejected. Editing preserves omitted fields. Moving
80
- a functionality changes its parent; moving test cases changes their assignment.
81
- Deleting a functionality unlinks its cases by default or transfers them to an
82
- active target when `target_id` is provided. Direct children become roots and keep
83
- their own cases.
77
+ Test-case creation and editing cover the fields in Sentinel's form: `ct_id`,
78
+ functionality, title, scenario type, Gherkin or ordered steps, priority, test and
79
+ scenario status, automation flag, platforms, notes, objective, preconditions,
80
+ estimated time, tags and assignee. Tags are plain strings (up to 10, 50 characters
81
+ each); pass `tags: []` when editing to remove all tags. For step-based cases, set
82
+ `description_mode` to `steps` and provide at least one action; switching back to
83
+ `gherkin` requires non-empty Gherkin text. List responses include tags and saved
84
+ metadata; `sentinel_get_test_case` returns the complete content and ordered steps.
85
+
86
+ Functionalities can be nested at any depth. `parent_id` identifies the immediate
87
+ parent, which may be any functionality in the same project; an omitted or null
88
+ parent creates or promotes a root. The paginated list is flat, so follow every
89
+ page to reconstruct the full hierarchy. Sentinel validates project scope and
90
+ rejects self-parenting or cycles, including moves under a node's own descendant.
91
+ Moving a functionality changes its parent while its descendants and test cases
92
+ stay attached. Moving test cases is a separate operation that changes their
93
+ assignment. Deleting a functionality unlinks its cases by default or transfers
94
+ them to an active target when `target_id` is provided. Direct children become
95
+ roots; deeper descendants remain attached to those children.
84
96
 
85
97
  Reading functionalities requires `features.view`; creation requires
86
98
  `features.create`; edits and hierarchy changes require `features.edit`. Case
@@ -114,11 +126,12 @@ replace it in your client configuration.
114
126
  ## Upgrade from 1.x
115
127
 
116
128
  Version 2.0.0 introduced the Node.js 22 minimum; Node.js 18 and 20 are not
117
- supported. Version 2.0.1 keeps that requirement and adds functionality management
118
- tools while preserving the existing eight tool names. Update a pinned
119
- `mcp-sentinel-qa@2.0.0` configuration to `mcp-sentinel-qa@2.0.1`, then restart or
120
- reconnect your MCP client. Older examples using `mcp-server-sentinel` should use
121
- `mcp-sentinel-qa` instead.
129
+ supported. Version 2.0.1 added functionality management tools, and 2.0.2 updated
130
+ their hierarchy guidance for trees at any depth. Version 2.0.3 completes the
131
+ test-case fields available through MCP, including tags and structured steps.
132
+ Update a pinned `mcp-sentinel-qa@2.0.2` configuration to
133
+ `mcp-sentinel-qa@2.0.3`, then restart or reconnect your MCP client. Older
134
+ examples using `mcp-server-sentinel` should use `mcp-sentinel-qa` instead.
122
135
 
123
136
  ## Development and release checks
124
137
 
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcp-sentinel-qa",
3
- "version": "2.0.1",
3
+ "version": "2.0.3",
4
4
  "description": "MCP server for Sentinel QA — manage functionalities and test cases from any AI assistant",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -11,7 +11,7 @@ export function registerFunctionalityTools(server) {
11
11
  }
12
12
  function registerReads(server) {
13
13
  server.registerTool('sentinel_list_functionalities', {
14
- description: 'List project functionalities with parent_id and pagination. Follow pagination to see the complete two-level hierarchy.',
14
+ description: 'List project functionalities as flat, paginated rows. Each parent_id identifies the immediate parent; follow all pages to reconstruct the hierarchy at any depth.',
15
15
  inputSchema: listFunctionalitiesSchema,
16
16
  annotations: { readOnlyHint: true },
17
17
  }, ({ project_id, page = 1, page_size = 20 }) => toolRequest(() => api.get('/api/mcp/functionalities', {
@@ -20,32 +20,32 @@ function registerReads(server) {
20
20
  page_size: page_size?.toString(),
21
21
  })));
22
22
  server.registerTool('sentinel_get_functionality', {
23
- description: 'Get functionality details, including its project and parent. Read before editing or deleting.',
23
+ description: 'Get functionality details, including its project and immediate parent_id. Read before editing, moving or deleting.',
24
24
  inputSchema: getFunctionalitySchema,
25
25
  annotations: { readOnlyHint: true },
26
26
  }, ({ id }) => toolRequest(() => api.get(`/api/mcp/functionalities/${id}`)));
27
27
  }
28
28
  function registerCreate(server) {
29
29
  server.registerTool('sentinel_create_functionality', {
30
- description: 'Create a root or child functionality. parent_id must reference a root in the same project; omit it or use null for a root. Maximum depth is two levels.',
30
+ description: 'Create a root or nested functionality at any depth. parent_id may reference any functionality in the same project; omit it or use null for a root. Sentinel rejects cross-project parents and cycles.',
31
31
  inputSchema: createFunctionalitySchema,
32
32
  }, (params) => toolRequest(() => api.post('/api/mcp/functionalities', params)));
33
33
  }
34
34
  function registerUpdate(server) {
35
35
  server.registerTool('sentinel_update_functionality', {
36
- description: 'Partially edit name, description, color, status or parent_id. Omitted fields are preserved; null clears description/color or promotes to root. Cannot change project.',
36
+ description: 'Partially edit name, description, color, status or parent_id. Omitted fields are preserved; null clears description/color or promotes to root. A parent may be any node in the same project; Sentinel rejects cycles. Cannot change project.',
37
37
  inputSchema: updateFunctionalitySchema,
38
38
  }, ({ id, ...changes }) => toolRequest(() => api.patch(`/api/mcp/functionalities/${id}`, changes)));
39
39
  }
40
40
  function registerMove(server) {
41
41
  server.registerTool('sentinel_move_functionality', {
42
- description: 'Move a functionality under another root in the same project, or promote it with parent_id:null. A functionality with children cannot become a child. Test cases stay attached.',
42
+ description: 'Move a functionality branch under any node in the same project, or promote it with parent_id:null. Sentinel rejects moving a node under itself or one of its descendants. Descendants and test cases stay attached.',
43
43
  inputSchema: moveFunctionalitySchema,
44
44
  }, ({ id, parent_id }) => toolRequest(() => api.patch(`/api/mcp/functionalities/${id}`, { parent_id })));
45
45
  }
46
46
  function registerDelete(server) {
47
47
  server.registerTool('sentinel_delete_functionality', {
48
- description: 'Delete a functionality after confirming the target. Preserve all test cases: unlink them by default or transfer to target_id, an active functionality in the same project. Direct children become roots.',
48
+ description: 'Delete a functionality after confirming the target. Unlink its test cases by default or transfer them to target_id, an active functionality in the same project. Direct children become roots; deeper descendants remain attached to their parents.',
49
49
  inputSchema: deleteFunctionalitySchema,
50
50
  annotations: { destructiveHint: true },
51
51
  }, ({ id, target_id }) => toolRequest(() => api.del(`/api/mcp/functionalities/${id}${target_id ? `?target_id=${encodeURIComponent(target_id)}` : ''}`)));
@@ -9,7 +9,12 @@ const fields = {
9
9
  .optional()
10
10
  .describe('Hex color or null'),
11
11
  status: z.enum(['Ativa', 'Inativa']).describe('Functionality status'),
12
- parent_id: z.string().uuid().nullable().optional().describe('Root parent UUID; null for a root'),
12
+ parent_id: z
13
+ .string()
14
+ .uuid()
15
+ .nullable()
16
+ .optional()
17
+ .describe('Immediate parent UUID in the same project; omit or use null for a root. Any depth is supported.'),
13
18
  };
14
19
  export const listFunctionalitiesSchema = z
15
20
  .object({
@@ -49,7 +54,7 @@ export const moveFunctionalitySchema = z
49
54
  .string()
50
55
  .uuid()
51
56
  .nullable()
52
- .describe('New root parent UUID, or null to promote to root'),
57
+ .describe('Immediate parent UUID in the same project at any depth, or null to promote to root'),
53
58
  })
54
59
  .strict()
55
60
  .refine(({ id, parent_id }) => id !== parent_id, 'A functionality cannot be its own parent');
@@ -109,13 +109,41 @@ export function registerTestCaseTools(server) {
109
109
  // sentinel_create_test_case
110
110
  // =========================================================================
111
111
  server.registerTool('sentinel_create_test_case', {
112
- description: 'Create a new test case in Sentinel. Requires project_id (use sentinel_list_projects first). Use sentinel_list_functionalities to get functionality_id.',
112
+ description: 'Create a test case with Sentinel form fields, including tags, objective, preconditions, assignee and estimated time. Set description_mode to steps and provide steps for structured cases; otherwise provide Gherkin. Requires project_id; use the project and functionality list tools for IDs.',
113
113
  inputSchema: z.object({
114
114
  project_id: z.string().uuid().describe('Project UUID (required)'),
115
- functionality_id: z.string().uuid().optional().describe('Functionality UUID (optional)'),
116
- title: z.string().min(5).max(500).describe('Test case title (min 5 chars)'),
115
+ ct_id: z
116
+ .string()
117
+ .max(20)
118
+ .optional()
119
+ .describe('Optional test case identifier; generated when omitted'),
120
+ functionality_id: z
121
+ .string()
122
+ .uuid()
123
+ .nullable()
124
+ .optional()
125
+ .describe('Functionality UUID, or null to leave the case unassigned'),
126
+ title: z.string().min(5).max(200).describe('Test case title (5–200 chars)'),
117
127
  scenario_type: z.enum(['Positivo', 'Negativo']).describe('Scenario type'),
118
- gherkin: z.string().min(1).describe('Gherkin/BDD scenario text'),
128
+ description_mode: z
129
+ .enum(['gherkin', 'steps'])
130
+ .optional()
131
+ .describe('Use gherkin for BDD text (default) or steps for structured action/result steps'),
132
+ gherkin: z
133
+ .string()
134
+ .max(10000)
135
+ .nullable()
136
+ .optional()
137
+ .describe('Required when description_mode is gherkin'),
138
+ steps: z
139
+ .array(z.object({
140
+ step_number: z.number().int().min(1),
141
+ action: z.string().min(1).max(500),
142
+ expected_result: z.string().max(500).nullable().optional(),
143
+ }))
144
+ .min(1)
145
+ .optional()
146
+ .describe('Required when description_mode is steps; order is preserved'),
119
147
  priority: z.enum(['Baixa', 'Média', 'Alta']).describe('Priority level'),
120
148
  test_status: z.enum(['Automatizado', 'Manual']).describe('Test status'),
121
149
  should_automate: z.boolean().describe('Whether this test should be automated'),
@@ -127,8 +155,28 @@ export function registerTestCaseTools(server) {
127
155
  .enum(['Ativo', 'Inativo', 'Descontinuado'])
128
156
  .default('Ativo')
129
157
  .describe('Scenario status (default: Ativo)'),
130
- notes: z.string().optional().describe('Additional notes'),
131
- assigned_to: z.string().uuid().optional().describe('User UUID to assign the test case to'),
158
+ notes: z.string().max(5000).optional().describe('Additional notes'),
159
+ objective: z.string().max(10000).nullable().optional().describe('Test objective'),
160
+ preconditions: z.string().max(10000).nullable().optional().describe('Preconditions'),
161
+ estimated_time: z
162
+ .number()
163
+ .int()
164
+ .min(0)
165
+ .max(9999)
166
+ .nullable()
167
+ .optional()
168
+ .describe('Estimated time in minutes'),
169
+ tags: z
170
+ .array(z.string().max(50))
171
+ .max(10)
172
+ .optional()
173
+ .describe('Up to 10 tags, each up to 50 characters'),
174
+ assigned_to: z
175
+ .string()
176
+ .uuid()
177
+ .optional()
178
+ .nullable()
179
+ .describe('User UUID to assign the test case to'),
132
180
  }),
133
181
  }, async (params) => {
134
182
  try {
@@ -150,19 +198,35 @@ export function registerTestCaseTools(server) {
150
198
  // sentinel_update_test_case
151
199
  // =========================================================================
152
200
  server.registerTool('sentinel_update_test_case', {
153
- description: 'Update an existing test case. Supports partial updates — only provided fields will be changed. Use sentinel_get_test_case first to see current values.',
201
+ description: 'Partially update all Sentinel test-case fields, including tags and either Gherkin or structured steps. Omitted fields are preserved; pass tags: [] to clear tags. Use sentinel_get_test_case first to see current values.',
154
202
  inputSchema: z.object({
155
203
  id: z.string().uuid().describe('Test case UUID to update'),
156
204
  project_id: z.string().uuid().optional().describe('Project UUID'),
205
+ ct_id: z.string().max(20).optional().describe('Test case identifier'),
157
206
  functionality_id: z
158
207
  .string()
159
208
  .uuid()
160
209
  .optional()
161
210
  .nullable()
162
211
  .describe('Functionality UUID (null to remove)'),
163
- title: z.string().min(5).max(500).optional().describe('Test case title'),
212
+ title: z.string().min(5).max(200).optional().describe('Test case title'),
164
213
  scenario_type: z.enum(['Positivo', 'Negativo']).optional().describe('Scenario type'),
165
- gherkin: z.string().min(1).optional().describe('Gherkin/BDD scenario text'),
214
+ description_mode: z.enum(['gherkin', 'steps']).optional().describe('Test content format'),
215
+ gherkin: z
216
+ .string()
217
+ .max(10000)
218
+ .nullable()
219
+ .optional()
220
+ .describe('Gherkin text; required when switching to gherkin mode'),
221
+ steps: z
222
+ .array(z.object({
223
+ step_number: z.number().int().min(1),
224
+ action: z.string().min(1).max(500),
225
+ expected_result: z.string().max(500).nullable().optional(),
226
+ }))
227
+ .min(1)
228
+ .optional()
229
+ .describe('Structured steps; set description_mode to steps'),
166
230
  priority: z.enum(['Baixa', 'Média', 'Alta']).optional().describe('Priority level'),
167
231
  test_status: z.enum(['Automatizado', 'Manual']).optional().describe('Test status'),
168
232
  should_automate: z.boolean().optional().describe('Whether this test should be automated'),
@@ -175,7 +239,37 @@ export function registerTestCaseTools(server) {
175
239
  .enum(['Ativo', 'Inativo', 'Descontinuado'])
176
240
  .optional()
177
241
  .describe('Scenario status'),
178
- notes: z.string().optional().nullable().describe('Additional notes (null to remove)'),
242
+ notes: z
243
+ .string()
244
+ .max(5000)
245
+ .optional()
246
+ .nullable()
247
+ .describe('Additional notes (null to remove)'),
248
+ objective: z
249
+ .string()
250
+ .max(10000)
251
+ .optional()
252
+ .nullable()
253
+ .describe('Test objective (null to clear)'),
254
+ preconditions: z
255
+ .string()
256
+ .max(10000)
257
+ .optional()
258
+ .nullable()
259
+ .describe('Preconditions (null to clear)'),
260
+ estimated_time: z
261
+ .number()
262
+ .int()
263
+ .min(0)
264
+ .max(9999)
265
+ .optional()
266
+ .nullable()
267
+ .describe('Estimated time in minutes (null to clear)'),
268
+ tags: z
269
+ .array(z.string().max(50))
270
+ .max(10)
271
+ .optional()
272
+ .describe('Replace all tags; pass [] to remove all tags'),
179
273
  assigned_to: z
180
274
  .string()
181
275
  .uuid()
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcp-sentinel-qa",
3
- "version": "2.0.1",
3
+ "version": "2.0.3",
4
4
  "description": "MCP server for Sentinel QA — manage functionalities and test cases from any AI assistant",
5
5
  "type": "module",
6
6
  "license": "MIT",