fmea-api-mcp-server 1.1.46 → 1.1.48

package/dist/index.js

@@ -28,7 +28,7 @@ class ApiDocsServer {
     constructor() {
         this.server = new Server({
             name: "api-docs-mcp",
-            version: "1.1.46",
+            version: "1.1.48",
         }, {
             capabilities: {
                 resources: {},

package/dist/synonyms.js

@@ -45,7 +45,7 @@ export const RESOURCE_ALIASES = {
     'recommendation-item': ['recommendation item', 'recommended action', 'corrective action', 'action item', 'mitigation item'], // [R20] New v2 recommendation items
     'fourm': ['4m', 'four m', '4m analysis', 'man machine material environment'], // 4M Analysis
     'term': ['term', 'terms', 'taxonomy', 'terminology', 'glossary'], // Term tree management — removed 'classification' (now dedicated resource [R28])
-    'condition-library': ['condition library', 'stress condition', 'design condition', 'process condition', 'stress library', 'design library', 'process library'], // [R24] Condition library resource
+    'condition-library': ['condition library', 'stress condition', 'design condition', 'process condition', 'stress library', 'design library', 'process library', 'factor', 'common term', 'common terms', 'shared term'], // [R24] [R38] Added factor/common term aliases
     'system-definition': ['system definition', 'system def', 'sys def', 'system spec', 'system specification', 'system function', 'system requirement'], // [R21] New system definition resource — removed 'condition/conditions' to avoid conflict with condition-library
     'system-definition-excel': ['system definition excel', 'system definition import', 'system definition export', 'conditions export', 'conditions import', 'export conditions', 'import conditions'], // [R23] Excel import/export for system definition conditions
     'high-item': ['high item', 'high items', 'high priority item', 'high priority risk', 'high priority', 'top item', 'top risk', 'risk ranking', 'high risk', 'priority list', 'batch upsert items', 'reorder items'], // [R23] High items resource
@@ -66,7 +66,7 @@ export const SYNONYM_GROUPS = {
     // Read / Retrieve
     "get": ["fetch", "retrieve", "read", "load", "find", "search", "query", "list", "show", "details"],
     "find": ["get", "search", "retrieve", "lookup", "show", "detect", "locate"],
-    "search": ["find", "get", "query", "lookup", "show", "explore", "scan"],
+    "search": ["find", "get", "lookup", "query", "show", "explore", "scan"], // [R38] moved "query" to pos4 to avoid false path-boost on /tree-search/.../query
     "show": ["get", "display", "view", "fetch", "find", "present"],
     "list": ["get", "all", "collection", "show", "summary", "index", "catalog"],
     "summary": ["list", "all", "overview", "collection", "report", "stats"],
@@ -79,6 +79,7 @@ export const SYNONYM_GROUPS = {
     "update": ["modify", "edit", "change", "save", "put", "patch", "set", "refresh", "renew", "upgrade"],
     "modify": ["update", "edit", "change", "adjust", "alter", "tweak"],
     "save": ["update", "store", "persist", "write", "record", "commit"],
+    "replace": ["overwrite", "substitute", "swap", "update", "save", "put"], // [R38] replace → save/update for bulk-replace endpoints
     "set": ["update", "assign", "define", "configure", "specify"],
     // Delete
     "delete": ["remove", "destroy", "clear", "erase", "drop", "cancel", "archive", "unlink"],

package/endpoints/v2/additional-info/core.json

@@ -119,9 +119,17 @@
         {
           "name": "fmeaType",
           "in": "query",
-          "description": "FMEA project type (e.g. DFMEA, PFMEA)",
+          "description": "FMEA project type",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DESIGN",
+              "PROCESS",
+              "EQUIPMENT",
+              "FA",
+              "FTA",
+              "CPLAN"
+            ]
           }
         }
       ],
@@ -316,9 +324,17 @@
         {
           "name": "fmeaType",
           "in": "query",
-          "description": "FMEA project type (e.g. DFMEA, PFMEA)",
+          "description": "FMEA project type",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DESIGN",
+              "PROCESS",
+              "EQUIPMENT",
+              "FA",
+              "FTA",
+              "CPLAN"
+            ]
           }
         }
       ],
@@ -418,9 +434,17 @@
         {
           "name": "fmeaType",
           "in": "query",
-          "description": "FMEA project type (e.g. DFMEA, PFMEA)",
+          "description": "FMEA project type",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "DESIGN",
+              "PROCESS",
+              "EQUIPMENT",
+              "FA",
+              "FTA",
+              "CPLAN"
+            ]
           }
         },
         {

package/endpoints/v2/api-keys/core.json

@@ -7,13 +7,16 @@
       "path": "/api/v2/admin/api-keys/{id}",
       "method": "DELETE",
       "operationId": "deactivate",
-      "summary": "Deactivate API key",
-      "description": "Administrators can forcibly deactivate (disable) any API key in the system using its unique ID. This operation immediately invalidates the key, preventing any further API requests authenticated with it. Use this endpoint to revoke compromised keys, enforce security policies, or manage user access. Unlike user-initiated deletion, this is an administrative override that requires ADMIN privileges and standard session authentication (API key authentication is explicitly blocked). The key is soft-deactivated and may be retained for audit purposes. Related actions include bulk deactivation by user ID and viewing audit logs of administrative actions.",
-      "tags": [],
+      "summary": "Force-deactivate an API key by ID",
+      "description": "Immediately deactivates the specified API key regardless of its owner. Only accessible via session (JWT) authentication; API key auth is rejected. Returns 204 No Content on success.",
+      "tags": [
+        "Admin - API Keys"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "API key ID to deactivate",
           "required": true,
           "schema": {
             "type": "integer",
@@ -34,13 +37,16 @@
       "path": "/api/v2/admin/api-keys/user/{userid}",
       "method": "DELETE",
       "operationId": "deactivateByUserId",
-      "summary": "Deactivate API keys by user ID",
-      "description": "Administrators can bulk deactivate (revoke) all API keys belonging to a specific user in a single operation. This is useful for immediately revoking all API access when a user is disabled, leaves the organization, or has their credentials compromised. The endpoint returns a count of deactivated keys. Requires ADMIN privileges and standard session authentication (API key authentication is explicitly blocked for security reasons). Unlike individual key deactivation, this targets all keys associated with the specified user ID. For targeted deactivation of specific keys, use the individual key deactivation endpoint. This action is logged in the admin audit trail for compliance and security monitoring.",
-      "tags": [],
+      "summary": "Deactivate all API keys for a specific user",
+      "description": "Bulk-deactivates all active API keys belonging to the specified user. Only accessible via session (JWT) authentication; API key auth is rejected. Returns the count of deactivated keys in the response body.",
+      "tags": [
+        "Admin - API Keys"
+      ],
       "parameters": [
         {
           "name": "userid",
           "in": "path",
+          "description": "User ID whose API keys will be deactivated",
           "required": true,
           "schema": {
             "type": "string"
@@ -61,8 +67,10 @@
       "method": "GET",
       "operationId": "getStats",
       "summary": "Get API key statistics",
-      "description": "Retrieves system-wide statistics and metrics about API keys for administrative monitoring and reporting. Provides aggregate data including total key count, active vs inactive keys, expired keys, and usage patterns. Use this endpoint for dashboard displays, capacity planning, security auditing, and compliance reporting. Requires ADMIN privileges and standard session authentication (API key authentication is blocked). Statistics are calculated in real-time from the current database state. Complementary to this endpoint, use the admin list endpoint for detailed key information with filters, and the audit logs endpoint for tracking administrative actions on keys.",
-      "tags": [],
+      "description": "Returns aggregate statistics for all API keys in the system, including total count, active/inactive counts, and expiry distribution. Only accessible via session (JWT) authentication; API key auth is rejected.",
+      "tags": [
+        "Admin - API Keys"
+      ],
       "parameters": [],
       "responses": {
         "default": {
@@ -115,13 +123,16 @@
       "path": "/api/v2/admin/api-keys",
       "method": "GET",
       "operationId": "list_3",
-      "summary": "List API keys (Admin)",
-      "description": "Administrators can retrieve a comprehensive, paginated list of all API keys across the system with powerful filtering capabilities. Supports filtering by user ID, activation status (active/inactive), and expiration status (expired keys only). Use this endpoint for security audits, compliance reporting, user management, and monitoring API key distribution across the organization. Returns detailed key metadata including owner, creation date, expiration, and status. Requires ADMIN privileges and standard session authentication (API key authentication is blocked). Page size is limited to 100 items per request for performance. This is the administrative counterpart to the user-specific list endpoint, providing visibility into all keys rather than just the authenticated user's keys.",
-      "tags": [],
+      "summary": "List all API keys across all users",
+      "description": "Returns a paged list of API keys for all users. Supports filtering by user ID, active status, and expiry state. Only accessible via session (JWT) authentication; API key auth is rejected. Page size is capped at 100.",
+      "tags": [
+        "Admin - API Keys"
+      ],
       "parameters": [
         {
           "name": "userid",
           "in": "query",
+          "description": "Filter by user ID (optional, exact match)",
           "schema": {
             "type": "string"
           }
@@ -129,6 +140,7 @@
         {
           "name": "isActive",
           "in": "query",
+          "description": "Filter by active status: true=active only, false=inactive only",
           "schema": {
             "type": "boolean"
           }
@@ -136,6 +148,7 @@
         {
           "name": "expiredOnly",
           "in": "query",
+          "description": "If true, return only expired keys",
           "schema": {
             "type": "boolean"
           }
@@ -143,6 +156,7 @@
         {
           "name": "page",
           "in": "query",
+          "description": "Page number (default: 1)",
           "schema": {
             "type": "integer",
             "default": 1,
@@ -152,6 +166,7 @@
         {
           "name": "size",
           "in": "query",
+          "description": "Page size (default: 20, max: 100)",
           "schema": {
             "type": "integer",
             "default": 20,
@@ -238,13 +253,16 @@
       "path": "/api/v2/admin/apikeys/logs",
       "method": "GET",
       "operationId": "getAuditLogs",
-      "summary": "Get API key audit logs",
-      "description": "Retrieves administrative audit logs tracking all management actions performed on API keys, providing a complete trail for security monitoring and compliance. Logs include deactivations, bulk revocations, and other administrative operations with timestamps, acting admin, target users, and action types. Supports filtering by administrator user ID, target user ID, action type, and date ranges (start/end dates). Use this endpoint for forensic analysis, security incident response, compliance auditing, and investigating unauthorized access attempts. Requires ADMIN privileges and standard session authentication (API key authentication is blocked). Results are paginated with a maximum of 100 items per page. This differs from user-facing usage logs which track API requests made using keys, whereas this tracks administrative management actions on keys themselves.",
-      "tags": [],
+      "summary": "Query API key audit logs",
+      "description": "Returns a paged list of API key admin actions (create, deactivate, etc.). Supports filtering by admin user ID, target user ID, action type, and date range. Dates must be in ISO-8601 format (YYYY-MM-DD). Only accessible via session (JWT) authentication; API key auth is rejected. Page size is capped at 100.",
+      "tags": [
+        "Admin - API Key Audit Logs"
+      ],
       "parameters": [
         {
           "name": "adminUserid",
           "in": "query",
+          "description": "Filter by the admin who performed the action (optional, exact match)",
           "schema": {
             "type": "string"
           }
@@ -252,6 +270,7 @@
         {
           "name": "targetUserid",
           "in": "query",
+          "description": "Filter by the user whose key was affected (optional, exact match)",
           "schema": {
             "type": "string"
           }
@@ -259,13 +278,20 @@
         {
           "name": "action",
           "in": "query",
+          "description": "Filter by action type",
           "schema": {
-            "type": "string"
+            "type": "string",
+            "enum": [
+              "ADD",
+              "DELETE",
+              "UPDATE"
+            ]
           }
         },
         {
           "name": "startDate",
           "in": "query",
+          "description": "Start date for the log query range (ISO-8601, YYYY-MM-DD, inclusive)",
           "schema": {
             "type": "string"
           }
@@ -273,6 +299,7 @@
         {
           "name": "endDate",
           "in": "query",
+          "description": "End date for the log query range (ISO-8601, YYYY-MM-DD, inclusive)",
           "schema": {
             "type": "string"
           }
@@ -280,6 +307,7 @@
         {
           "name": "page",
           "in": "query",
+          "description": "Page number (default: 1)",
           "schema": {
             "type": "integer",
             "default": 1,
@@ -289,6 +317,7 @@
         {
           "name": "size",
           "in": "query",
+          "description": "Page size (default: 20, max: 100)",
           "schema": {
             "type": "integer",
             "default": 20,
@@ -360,9 +389,11 @@
       "path": "/api/v2/api-keys",
       "method": "GET",
       "operationId": "list_4",
-      "summary": "List API keys",
-      "description": "Retrieves all API keys belonging to the currently authenticated user, providing a comprehensive view of their personal API access credentials. Returns key metadata including key identifier, name, creation date, expiration date, activation status, and last used timestamp. Use this endpoint to manage your API keys, review active credentials, monitor key usage, and identify expired or inactive keys that can be cleaned up. Requires READER level authentication or higher. This is the user-facing counterpart to the administrative list endpoint, which shows all keys across the system. Users can only view their own keys for security isolation. For detailed usage analytics on individual keys, use the logs and log summary endpoints with a specific key ID.",
-      "tags": [],
+      "summary": "List all API keys for the authenticated user",
+      "description": "Returns all API keys belonging to the currently authenticated user, including active and inactive keys. Key values are masked in the response.",
+      "tags": [
+        "API Keys"
+      ],
       "parameters": [],
       "responses": {
         "default": {
@@ -433,9 +464,11 @@
       "path": "/api/v2/api-keys",
       "method": "POST",
       "operationId": "create_1",
-      "summary": "Create API key",
-      "description": "Generates and issues a new API key for the authenticated user, enabling programmatic access to the FMEA API. The request must specify a descriptive name for the key and an optional expiration date. Upon creation, the full API key value is returned in the response (this is the only time it will be displayed in plain text, so store it securely). Use this endpoint to create keys for API integrations, automated scripts, third-party applications, or CI/CD pipelines. Requires READER level authentication or higher. Each key is unique, cryptographically secure, and associated with the creating user's identity for audit purposes. Keys can be managed (listed, deleted, regenerated) through the other endpoints in this API. If a key is compromised, use the regenerate endpoint to create a new secret without changing the key ID, or delete it entirely.",
-      "tags": [],
+      "summary": "Issue a new API key for the authenticated user",
+      "description": "Creates and returns a new API key for the currently authenticated user. The key is returned in full only at creation time; subsequent list calls return only the masked key. Returns 201 Created on success.",
+      "tags": [
+        "API Keys"
+      ],
       "parameters": [],
       "requestBody": {
         "content": {
@@ -521,13 +554,16 @@
       "path": "/api/v2/api-keys/{id}",
       "method": "DELETE",
       "operationId": "delete_1",
-      "summary": "Delete API key",
-      "description": "Permanently deletes (removes) an API key belonging to the authenticated user. This operation immediately invalidates the key, preventing any further API requests authenticated with it. Use this endpoint to revoke compromised credentials, clean up unused keys, or remove keys that are no longer needed for security best practices. Requires READER level authentication or higher. Users can only delete their own keys for security isolation. The deletion is permanent and cannot be undone, so ensure the key is not in active use before deletion. For temporary revocation where you might want to reactivate later, consider using administrative deactivation instead (requires admin privileges). This endpoint returns no content on success (HTTP 204). Always verify you are deleting the correct key ID, as the action is irreversible.",
-      "tags": [],
+      "summary": "Delete an API key owned by the authenticated user",
+      "description": "Permanently deletes the specified API key. The key must belong to the currently authenticated user. Returns 204 No Content on success.",
+      "tags": [
+        "API Keys"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "API key ID to delete",
           "required": true,
           "schema": {
             "type": "integer",
@@ -548,13 +584,16 @@
       "path": "/api/v2/api-keys/{id}/logs",
       "method": "GET",
       "operationId": "getLogs",
-      "summary": "Get API key usage logs",
-      "description": "Retrieves detailed usage logs for a specific API key owned by the authenticated user, showing all API requests made using that key. Each log entry includes timestamp, endpoint path, HTTP method, response status code, and request metadata. Supports filtering by date range (start/end dates), specific endpoint, and HTTP status code for targeted analysis. Results are paginated with a maximum of 100 items per page. Use this endpoint for security monitoring, debugging integration issues, tracking API usage patterns, and identifying suspicious activity. Requires READER level authentication or higher. Users can only view logs for their own keys. This provides granular request-level detail, while the summary endpoint offers aggregated statistics. The log retention period applies, so very old logs may not be available.",
-      "tags": [],
+      "summary": "Get usage logs for an API key",
+      "description": "Returns paged usage logs for the specified API key owned by the authenticated user. Supports filtering by date range, endpoint path, and HTTP status code. Dates must be in ISO-8601 format (YYYY-MM-DD). Page size is capped at 100.",
+      "tags": [
+        "API Keys"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "API key ID",
           "required": true,
           "schema": {
             "type": "integer",
@@ -564,6 +603,7 @@
         {
           "name": "startDate",
           "in": "query",
+          "description": "Start date for the log range (ISO-8601, YYYY-MM-DD, inclusive)",
           "schema": {
             "type": "string"
           }
@@ -571,6 +611,7 @@
         {
           "name": "endDate",
           "in": "query",
+          "description": "End date for the log range (ISO-8601, YYYY-MM-DD, inclusive)",
           "schema": {
             "type": "string"
           }
@@ -578,6 +619,7 @@
         {
           "name": "endpoint",
           "in": "query",
+          "description": "Filter by called endpoint path (optional, partial match)",
           "schema": {
             "type": "string"
           }
@@ -585,6 +627,7 @@
         {
           "name": "statusCode",
           "in": "query",
+          "description": "Filter by HTTP status code (optional, e.g., 200, 401, 500)",
           "schema": {
             "type": "integer",
             "format": "int32"
@@ -593,6 +636,7 @@
         {
           "name": "page",
           "in": "query",
+          "description": "Page number (default: 0)",
           "schema": {
             "type": "integer",
             "default": 0,
@@ -602,6 +646,7 @@
         {
           "name": "size",
           "in": "query",
+          "description": "Page size (default: 20, max: 100)",
           "schema": {
             "type": "integer",
             "default": 20,
@@ -622,13 +667,16 @@
       "path": "/api/v2/api-keys/{id}/logs/summary",
       "method": "GET",
       "operationId": "getLogsSummary",
-      "summary": "Get API key logs summary",
-      "description": "Retrieves aggregated usage statistics and summary analytics for a specific API key owned by the authenticated user. Provides high-level metrics including total request count, success rate (2xx/3xx vs 4xx/5xx), most frequently used endpoints, error breakdown, and activity timeline within the specified date range. Use this endpoint for usage analytics, quota monitoring, identifying integration health, and generating usage reports without processing individual log entries. Requires READER level authentication or higher. Users can only view summaries for their own keys. Supports optional date range filtering to analyze specific time periods. This complements the detailed logs endpoint by providing pre-aggregated insights for quick assessment of API key performance and usage patterns.",
-      "tags": [],
+      "summary": "Get usage log summary for an API key",
+      "description": "Returns aggregated usage statistics for the specified API key owned by the authenticated user. Supports filtering by date range (ISO-8601 YYYY-MM-DD). Includes total request counts grouped by status code and endpoint.",
+      "tags": [
+        "API Keys"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "API key ID",
           "required": true,
           "schema": {
             "type": "integer",
@@ -638,6 +686,7 @@
         {
           "name": "startDate",
           "in": "query",
+          "description": "Start date for the summary range (ISO-8601, YYYY-MM-DD, inclusive)",
           "schema": {
             "type": "string"
           }
@@ -645,6 +694,7 @@
         {
           "name": "endDate",
           "in": "query",
+          "description": "End date for the summary range (ISO-8601, YYYY-MM-DD, inclusive)",
           "schema": {
             "type": "string"
           }
@@ -714,13 +764,16 @@
       "path": "/api/v2/api-keys/{id}/regenerate",
       "method": "POST",
       "operationId": "regenerate",
-      "summary": "Regenerate API key",
-      "description": "Regenerates (replaces the secret value of) an existing API key while preserving its ID and metadata. This operation creates a new cryptographically secure key value, immediately invalidating the old secret. The full new API key value is returned in the response (store it securely, as this is the only time it will be displayed). Optionally accepts a new expiration date. Use this endpoint to rotate credentials for security compliance, respond to potential key exposure, or implement periodic key rotation policies without changing integration configuration. Requires READER level authentication or higher. Users can only regenerate their own keys. The old key becomes invalid immediately upon regeneration, so update all applications using the key promptly. This differs from deletion + recreation in that the key ID remains stable, making it easier to update integrations.",
-      "tags": [],
+      "summary": "Regenerate an API key",
+      "description": "Replaces the secret value of an existing API key with a newly generated one. An optional new expiry date may be specified in the request body. The new key value is returned in full only in this response.",
+      "tags": [
+        "API Keys"
+      ],
       "parameters": [
         {
           "name": "id",
           "in": "path",
+          "description": "API key ID to regenerate",
           "required": true,
           "schema": {
             "type": "integer",

package/endpoints/v2/block-diagrams/core.json

@@ -720,13 +720,16 @@
       "path": "/api/v2/template/block-diagrams/{blockDiagramType}/sheet-headers",
       "method": "GET",
       "operationId": "getBlockDiagramSheetHeaders",
-      "summary": "Get Block Diagram Excel Sheet Headers (v2)",
-      "description": "Retrieves the standardized Excel sheet headers and column definitions for a specific block diagram type. Use this endpoint to obtain the expected column structure, field names, and data format requirements when creating or validating Excel files for block diagram import. This is essential for ensuring Excel uploads conform to the correct schema, preventing import errors and data validation failures. The response defines all required and optional columns, data types, and formatting rules. Supports dynamic template generation and client-side Excel validation. Critical for building import interfaces, spreadsheet validation tools, and documentation generation. Use before attempting Excel data import operations.",
-      "tags": [],
+      "summary": "Get block diagram Excel sheet headers for a given diagram type",
+      "description": "Returns the ordered list of column headers used in the Excel import/export sheet for the specified block diagram type. Valid values for blockDiagramType: P-DIAGRAM, BOUNDARY-DIAGRAM.",
+      "tags": [
+        "Template"
+      ],
       "parameters": [
         {
           "name": "blockDiagramType",
           "in": "path",
+          "description": "Block diagram type",
           "required": true,
           "schema": {
             "type": "string",