fmea-api-mcp-server 1.1.45 → 1.1.47

package/endpoints/v2/worksheets/core.json

@@ -6,13 +6,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets",
       "method": "GET",
-      "summary": "Get worksheet summaries",
-      "description": "Retrieves a list of all worksheet summaries within a project. This endpoint provides a high-level overview (summary/directory) of available worksheets, excluding detailed content. Use this to browse, list, or enumerate worksheets before fetching specific worksheet details. The response contains basic metadata such as report numbers and titles. Ideal for dashboard views, worksheet selection interfaces, or getting a quick inventory of all worksheets in a project. No authentication required for read access.",
-      "tags": [],
+      "summary": "List worksheet summaries for a project",
+      "description": "Returns summary information for all worksheets belonging to the given project. Each summary includes the report number, title, and status. Requires NORMAL user level.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID to list worksheets for",
           "required": true,
           "schema": {
             "type": "string"
@@ -118,13 +121,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets",
       "method": "POST",
-      "summary": "Create worksheet",
-      "description": "Creates a new worksheet within the specified project. Use this endpoint to initialize a blank worksheet, set up a new analysis document, or establish a fresh worksheet structure. The request accepts worksheet creation parameters via WorksheetCreationDTO. Upon successful creation, returns the report number (reportNoSimple) of the newly created worksheet. Requires NORMAL user level and PROJECT MEMBER role. This is the initiating action for any worksheet-based workflow. Common use cases include: starting a new FMEA analysis, creating additional worksheets for different subsystems, or generating worksheet templates.",
-      "tags": [],
+      "summary": "Create a new worksheet in a project",
+      "description": "Creates a new worksheet under the given project using the provided creation DTO. Returns HTTP 201 Created with a Location header pointing to the new worksheet. Requires NORMAL user level and project MEMBER role.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID to create the worksheet under",
           "required": true,
           "schema": {
             "type": "string"
@@ -177,13 +183,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
       "method": "GET",
-      "summary": "Get worksheet by report number",
-      "description": "Fetches the complete details of a specific worksheet identified by its report number. The reportNoSimple parameter accepts formats like '3' or '3-1' (handling sub-worksheets via ReportNoSetDTO). Returns the full worksheet data including all rows, columns, headers, and cell values. Use this endpoint after listing summaries to retrieve detailed content for editing or analysis. Requires NORMAL user level. Common scenarios include: loading a worksheet for editing, viewing worksheet content, exporting worksheet data, or fetching worksheet structure for UI rendering. This is the primary read operation for full worksheet content.",
-      "tags": [],
+      "summary": "Get worksheet detail by report number",
+      "description": "Returns the full worksheet detail for the given report number within a project. Report number format: 'N' for primary only (e.g. '3'), or 'N-M' for primary-secondary (e.g. '3-1'). The '#' prefix is optional and will be stripped. Requires NORMAL user level.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -192,6 +201,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
           "required": true,
           "schema": {
             "type": "string"
@@ -270,13 +280,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
       "method": "PUT",
-      "summary": "Update worksheet",
-      "description": "Updates and saves changes to an existing worksheet identified by its report number. Accepts WorksheetSaveDTO containing modified worksheet data including cell values, structure changes, and metadata updates. The reportNoSimple parameter supports both simple numbers ('3') and sub-worksheet notation ('3-1'). All changes are persisted to the database. Requires NORMAL user level and PROJECT MEMBER role with write permissions. Common use cases: saving worksheet edits, updating cell values, modifying worksheet structure, applying bulk changes, or synchronizing client-side modifications. This is the primary write operation for worksheets and should be called after any user modifications to persist data.",
-      "tags": [],
+      "summary": "Save worksheet data by report number",
+      "description": "Saves (updates) the worksheet content for the given report number. Accepts a WorksheetSaveDTO containing row data and column values. Requires NORMAL user level and project MEMBER role.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -285,6 +298,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
           "required": true,
           "schema": {
             "type": "string"
@@ -419,13 +433,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNoSimple}",
       "method": "DELETE",
-      "summary": "Delete worksheet",
-      "description": "Permanently removes a worksheet from the project using its report number identifier. The reportNoSimple parameter accepts formats like '3' or '3-1' for sub-worksheets. This operation is irreversible and will delete all worksheet data including rows, columns, cell values, and associated metadata. Requires NORMAL user level and PROJECT MEMBER role. Use with caution as deleted worksheets cannot be recovered without database restore. Common scenarios: removing obsolete worksheets, cleaning up test data, deleting unused analysis documents, or managing worksheet lifecycle. Consider archiving instead of deleting if the worksheet might be needed for future reference.",
-      "tags": [],
+      "summary": "Delete worksheet by report number",
+      "description": "Deletes the worksheet identified by the report number within the project. Returns HTTP 200 on success. Requires NORMAL user level and project MEMBER role.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -434,6 +451,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Report number: 'N' (primary) or 'N-M' (primary-secondary), e.g. '3-1'",
           "required": true,
           "schema": {
             "type": "string"

package/endpoints/v2/worksheets/excel.json

@@ -6,13 +6,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheet-excel/{uuid}",
       "method": "PUT",
-      "summary": "Update worksheet Excel",
-      "description": "Updates an existing worksheet by importing data from an uploaded Excel file (.xlsx, .xls). Use this endpoint to modify worksheet contents, replace existing data, or refresh worksheet records with new Excel data. The endpoint parses the uploaded Excel file and updates the corresponding worksheet record. This is the primary method for editing worksheet data through Excel import. Requires project member role.",
-      "tags": [],
+      "summary": "Re-import a worksheet from an uploaded Excel file",
+      "description": "Updates an existing worksheet by re-importing data from a previously uploaded Excel file. Overwrites the worksheet content according to the provided column mapping configuration. Returns 204 No Content on success.",
+      "tags": [
+        "Worksheet Excel"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the worksheet",
           "required": true,
           "schema": {
             "type": "string"
@@ -21,6 +24,7 @@
         {
           "name": "uuid",
           "in": "path",
+          "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
           "required": true,
           "schema": {
             "type": "string"
@@ -79,13 +83,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheet-excel/{uuid}",
       "method": "POST",
-      "summary": "Add worksheet Excel",
-      "description": "Creates a new worksheet by importing data from an uploaded Excel file (.xlsx, .xls). Use this endpoint to add a new worksheet record, create worksheet entries from Excel, or import worksheet data from spreadsheet files. The endpoint parses the uploaded Excel file and creates a new worksheet with the data. Returns the created worksheet's report number for reference. Requires project member role.",
-      "tags": [],
+      "summary": "Import a new worksheet from an uploaded Excel file",
+      "description": "Creates a new worksheet by importing data from a previously uploaded Excel file. The file must be uploaded first via POST /api/v2/files. The request body specifies column mapping configuration. Returns the assigned report number (reportNoSetDTO) and a Location header pointing to the new worksheet.",
+      "tags": [
+        "Worksheet Excel"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that will own the new worksheet",
           "required": true,
           "schema": {
             "type": "string"
@@ -94,6 +101,7 @@
         {
           "name": "uuid",
           "in": "path",
+          "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
           "required": true,
           "schema": {
             "type": "string"
@@ -152,13 +160,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheet-excel/{reportNoSimple}",
       "method": "GET",
-      "summary": "Get worksheet Excel download link",
-      "description": "Generates a download link for a worksheet Excel file by report number. Use this endpoint to export worksheet data, download worksheet as Excel, or retrieve the spreadsheet file for offline editing. The link provides access to the Excel file associated with the specified worksheet report number. Requires reader-level access or higher.",
-      "tags": [],
+      "summary": "Get Excel download link for a worksheet",
+      "description": "Generates and returns a download link (FileDownloadResponseDTO) for exporting a worksheet as an Excel file. The report number identifies the worksheet (primary 'N' or primary-secondary 'N-M'). Use GET /api/v1/files/{uuid} with the returned URI to download the file.",
+      "tags": [
+        "Worksheet Excel"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the worksheet",
           "required": true,
           "schema": {
             "type": "string"
@@ -167,6 +178,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Worksheet report number: 'N' (primary) or 'N-M' (primary-secondary). '#' prefix is stripped.",
           "required": true,
           "schema": {
             "type": "string"
@@ -198,13 +210,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheet-excel/{uuid}/metadata",
       "method": "GET",
-      "summary": "Get worksheet Excel metadata",
-      "description": "Extracts metadata from an uploaded Excel file without processing the full data. Use this endpoint to preview file information, validate Excel structure, inspect worksheet contents, or retrieve file properties before saving. Returns metadata including sheet names, column headers, and data structure. Useful for pre-validating Excel files before add/update operations. Requires project member role.",
-      "tags": [],
+      "summary": "Get Excel file metadata for a worksheet import",
+      "description": "Reads metadata (sheet names, column headers) from a previously uploaded Excel file. The file must be uploaded first via POST /api/v2/files. The returned metadata is used to configure mapping before triggering import.",
+      "tags": [
+        "Worksheet Excel"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the worksheet",
           "required": true,
           "schema": {
             "type": "string"
@@ -213,6 +228,7 @@
         {
           "name": "uuid",
           "in": "path",
+          "description": "UUID of the uploaded Excel file (returned by POST /api/v2/files)",
           "required": true,
           "schema": {
             "type": "string"
@@ -262,14 +278,17 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheet-excel/{reportNoSimple}/sheets",
       "method": "GET",
-      "summary": "Get Excel Sheets List",
-      "description": "Fetches a complete list of available Excel worksheets/tabs associated with a specific previously generated or uploaded Excel report. Ideal for previewing workbook structure, selecting specific sheets for analysis, or retrieving metadata before detailed extraction. (List sheets / View Excel tabs / Get available worksheets).",
-      "tags": [],
+      "summary": "List POISheet sheets for a worksheet Excel",
+      "description": "Returns the list of POISheet sheet objects contained in the Excel file associated with the specified worksheet. Useful for rendering multi-sheet Excel content in the worksheet editor.",
+      "tags": [
+        "Worksheet Excel"
+      ],
       "operationId": "getSheets",
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID that owns the worksheet",
           "required": true,
           "schema": {
             "type": "string"
@@ -278,6 +297,7 @@
         {
           "name": "reportNoSimple",
           "in": "path",
+          "description": "Worksheet report number: 'N' (primary) or 'N-M' (primary-secondary). '#' prefix is stripped.",
           "required": true,
           "schema": {
             "type": "string"

package/endpoints/v2/worksheets/management.json

@@ -6,13 +6,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/failuremode/{failureModeId}",
       "method": "GET",
-      "summary": "Get worksheet by failure mode",
-      "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.",
-      "tags": [],
+      "summary": "Get worksheet by failure mode ID",
+      "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.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the failure mode belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -21,6 +24,7 @@
         {
           "name": "failureModeId",
           "in": "path",
+          "description": "Failure mode ID to retrieve the associated worksheet for",
           "required": true,
           "schema": {
             "type": "string"
@@ -58,13 +62,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/failuremode/{failureModeId}",
       "method": "POST",
-      "summary": "Create worksheet by failure mode",
-      "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.",
-      "tags": [],
+      "summary": "Create worksheet row for a failure mode",
+      "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.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the failure mode belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -73,6 +80,7 @@
         {
           "name": "failureModeId",
           "in": "path",
+          "description": "Failure mode ID to create a worksheet row for",
           "required": true,
           "schema": {
             "type": "string"
@@ -81,6 +89,7 @@
         {
           "name": "blockDiagramId",
           "in": "query",
+          "description": "Optional block diagram node ID to associate with the new worksheet row",
           "schema": {
             "type": "string"
           }
@@ -127,11 +136,14 @@
       "method": "GET",
       "summary": "Get worksheet headers",
       "description": "Returns worksheet headers copied for the worksheet. When search is provided, keyword matching is applied.",
-      "tags": [],
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -140,6 +152,7 @@
         {
           "name": "reportNo",
           "in": "path",
+          "description": "Worksheet report number (primary, e.g. '3')",
           "required": true,
           "schema": {
             "type": "string"
@@ -237,13 +250,16 @@
     {
       "path": "/api/v2/projects/{projectId}/worksheets/{reportNo}/{failureModeId}",
       "method": "PUT",
-      "summary": "Save worksheet by failure mode",
-      "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.",
-      "tags": [],
+      "summary": "Save worksheet data for a specific failure mode",
+      "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.",
+      "tags": [
+        "Worksheet"
+      ],
       "parameters": [
         {
           "name": "projectId",
           "in": "path",
+          "description": "Project ID the worksheet belongs to",
           "required": true,
           "schema": {
             "type": "string"
@@ -252,6 +268,7 @@
         {
           "name": "reportNo",
           "in": "path",
+          "description": "Worksheet report number (primary, e.g. '3')",
           "required": true,
           "schema": {
             "type": "string"
@@ -260,6 +277,7 @@
         {
           "name": "failureModeId",
           "in": "path",
+          "description": "Failure mode ID whose worksheet row will be updated",
           "required": true,
           "schema": {
             "type": "string"

package/endpoints/v2/worksheets/templates.json

@@ -8,11 +8,14 @@
       "method": "GET",
       "summary": "Get worksheet template headers",
       "description": "Returns worksheet template headers. When search is provided, keyword matching is applied.",
-      "tags": [],
+      "tags": [
+        "Worksheet Templates"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "Worksheet template ID",
           "required": true,
           "schema": {
             "type": "integer",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fmea-api-mcp-server",
-  "version": "1.1.45",
+  "version": "1.1.47",
   "description": "MCP server for serving API documentation from endpoints directory",
   "type": "module",
   "main": "dist/index.js",