fmea-api-mcp-server 1.1.46 → 1.1.47

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.
@@ -6,13 +6,16 @@
6
6
  {
7
7
  "path": "/api/v2/projects/{projectId}/worksheets/failuremode/{failureModeId}",
8
8
  "method": "GET",
9
- "summary": "Get worksheet by failure mode",
10
- "description": "Fetches the complete worksheet data associated with a specific failure mode within a project. Use this endpoint to retrieve, load, or view detailed failure mode analysis worksheets including RPN calculations, risk assessments, and mitigation strategies. This is essential for reviewing existing failure mode documentation, conducting quality audits, or preparing data for editing operations. The endpoint returns structured worksheet content that can be used for analysis, reporting, or further modification through the update endpoint.",
11
- "tags": [],
9
+ "summary": "Get worksheet by failure mode ID",
10
+ "description": "Returns the worksheet associated with the specified failure mode within the given project. Returns the worksheet DTO including S/O/D data and all worksheet rows. Requires NORMAL user level.",
11
+ "tags": [
12
+ "Worksheet"
13
+ ],
12
14
  "parameters": [
13
15
  {
14
16
  "name": "projectId",
15
17
  "in": "path",
18
+ "description": "Project ID the failure mode belongs to",
16
19
  "required": true,
17
20
  "schema": {
18
21
  "type": "string"
@@ -21,6 +24,7 @@
21
24
  {
22
25
  "name": "failureModeId",
23
26
  "in": "path",
27
+ "description": "Failure mode ID to retrieve the associated worksheet for",
24
28
  "required": true,
25
29
  "schema": {
26
30
  "type": "string"
@@ -58,13 +62,16 @@
58
62
  {
59
63
  "path": "/api/v2/projects/{projectId}/worksheets/failuremode/{failureModeId}",
60
64
  "method": "POST",
61
- "summary": "Create worksheet by failure mode",
62
- "description": "Generates a new worksheet for a specific failure mode within a project. Use this endpoint to initialize, set up, or create failure mode analysis worksheets. This operation establishes a structured worksheet template linked to the identified failure mode, optionally associating it with a block diagram via the blockDiagramId query parameter. Essential for starting new failure mode analyses, initiating risk assessment workflows, or expanding project documentation coverage. The created worksheet provides a framework for capturing RPN calculations, failure effects, causes, and recommended actions.",
63
- "tags": [],
65
+ "summary": "Create worksheet row for a failure mode",
66
+ "description": "Creates a new worksheet row linked to the specified failure mode within the project. Optionally associates the row with a block diagram node via blockDiagramId. Returns HTTP 201 Created with the created worksheet row DTO. Requires NORMAL user level and project MEMBER role.",
67
+ "tags": [
68
+ "Worksheet"
69
+ ],
64
70
  "parameters": [
65
71
  {
66
72
  "name": "projectId",
67
73
  "in": "path",
74
+ "description": "Project ID the failure mode belongs to",
68
75
  "required": true,
69
76
  "schema": {
70
77
  "type": "string"
@@ -73,6 +80,7 @@
73
80
  {
74
81
  "name": "failureModeId",
75
82
  "in": "path",
83
+ "description": "Failure mode ID to create a worksheet row for",
76
84
  "required": true,
77
85
  "schema": {
78
86
  "type": "string"
@@ -81,6 +89,7 @@
81
89
  {
82
90
  "name": "blockDiagramId",
83
91
  "in": "query",
92
+ "description": "Optional block diagram node ID to associate with the new worksheet row",
84
93
  "schema": {
85
94
  "type": "string"
86
95
  }
@@ -127,11 +136,14 @@
127
136
  "method": "GET",
128
137
  "summary": "Get worksheet headers",
129
138
  "description": "Returns worksheet headers copied for the worksheet. When search is provided, keyword matching is applied.",
130
- "tags": [],
139
+ "tags": [
140
+ "Worksheet"
141
+ ],
131
142
  "parameters": [
132
143
  {
133
144
  "name": "projectId",
134
145
  "in": "path",
146
+ "description": "Project ID the worksheet belongs to",
135
147
  "required": true,
136
148
  "schema": {
137
149
  "type": "string"
@@ -140,6 +152,7 @@
140
152
  {
141
153
  "name": "reportNo",
142
154
  "in": "path",
155
+ "description": "Worksheet report number (primary, e.g. '3')",
143
156
  "required": true,
144
157
  "schema": {
145
158
  "type": "string"
@@ -237,13 +250,16 @@
237
250
  {
238
251
  "path": "/api/v2/projects/{projectId}/worksheets/{reportNo}/{failureModeId}",
239
252
  "method": "PUT",
240
- "summary": "Save worksheet by failure mode",
241
- "description": "Updates and persists worksheet data for a specific failure mode within a designated report. Use this endpoint to save, modify, edit, or update failure mode analysis content including severity ratings, occurrence probabilities, detection rankings, RPN calculations, recommended actions, and status tracking. This operation overwrites existing data with the provided FailureModeWorksheetSaveDTO payload, ensuring data persistence and version control. Essential for recording analysis progress, updating risk assessments after reviews, documenting corrective actions, or maintaining live risk evaluation data. Requires project member role authentication and supports iterative refinement of failure mode analyses throughout the project lifecycle.",
242
- "tags": [],
253
+ "summary": "Save worksheet data for a specific failure mode",
254
+ "description": "Saves worksheet content for the worksheet row associated with the given failure mode. The report number identifies the worksheet; the failure mode ID identifies the row. Requires NORMAL user level and project MEMBER role.",
255
+ "tags": [
256
+ "Worksheet"
257
+ ],
243
258
  "parameters": [
244
259
  {
245
260
  "name": "projectId",
246
261
  "in": "path",
262
+ "description": "Project ID the worksheet belongs to",
247
263
  "required": true,
248
264
  "schema": {
249
265
  "type": "string"
@@ -252,6 +268,7 @@
252
268
  {
253
269
  "name": "reportNo",
254
270
  "in": "path",
271
+ "description": "Worksheet report number (primary, e.g. '3')",
255
272
  "required": true,
256
273
  "schema": {
257
274
  "type": "string"
@@ -260,6 +277,7 @@
260
277
  {
261
278
  "name": "failureModeId",
262
279
  "in": "path",
280
+ "description": "Failure mode ID whose worksheet row will be updated",
263
281
  "required": true,
264
282
  "schema": {
265
283
  "type": "string"
@@ -8,11 +8,14 @@
8
8
  "method": "GET",
9
9
  "summary": "Get worksheet template headers",
10
10
  "description": "Returns worksheet template headers. When search is provided, keyword matching is applied.",
11
- "tags": [],
11
+ "tags": [
12
+ "Worksheet Templates"
13
+ ],
12
14
  "parameters": [
13
15
  {
14
16
  "name": "id",
15
17
  "in": "path",
18
+ "description": "Worksheet template ID",
16
19
  "required": true,
17
20
  "schema": {
18
21
  "type": "integer",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fmea-api-mcp-server",
3
- "version": "1.1.46",
3
+ "version": "1.1.47",
4
4
  "description": "MCP server for serving API documentation from endpoints directory",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",