mcp4openapi 0.2.7 → 0.3.0

package/profiles/n8n/profile-optimized.json

@@ -0,0 +1,965 @@
+{
+  "$schema": "../../profile-schema.json",
+  "profile_name": "n8n-optimized",
+  "profile_id": "n8n-optimized",
+  "profile_aliases": [
+    "n8n-optimized"
+  ],
+  "openapi_spec_path": "./openapi.yaml",
+  "description": "n8n Public API - minimal tools grouped by read/write operations",
+  "parameter_aliases": {
+    "id": [
+      "credential_id",
+      "execution_id",
+      "tag_id",
+      "user_id",
+      "variable_id",
+      "workflow_id"
+    ],
+    "projectId": [
+      "project_id"
+    ],
+    "userId": [
+      "user_id"
+    ],
+    "workflowId": [
+      "workflow_id"
+    ],
+    "versionId": [
+      "version_id"
+    ],
+    "credentialTypeName": [
+      "credential_type_name"
+    ],
+    "includeData": [
+      "include_data"
+    ],
+    "includeRole": [
+      "include_role"
+    ]
+  },
+  "tools": [
+    {
+      "name": "retrieve_n8n",
+      "description": "Read-only access to n8n resources (list/get).",
+      "metadata_params": [
+        "action"
+      ],
+      "operations": {
+        "get_credential_schema": "get_/credentials/schema/{credentialTypeName}",
+        "list_executions": "get_/executions",
+        "get_execution": "get_/executions/{id}",
+        "list_projects": "get_/projects",
+        "list_tags": "get_/tags",
+        "get_tag": "get_/tags/{id}",
+        "list_users": "get_/users",
+        "get_user": "get_/users/{id}",
+        "list_variables": "get_/variables",
+        "list_workflows": "get_/workflows",
+        "get_workflow": "get_/workflows/{id}",
+        "get_workflow_version": "get_/workflows/{id}/{versionId}",
+        "get_workflow_tags": "get_/workflows/{id}/tags"
+      },
+      "parameters": {
+        "id": {
+          "type": [
+            "string",
+            "number"
+          ],
+          "description": "Property id",
+          "required_for": [
+            "get_execution",
+            "get_tag",
+            "get_user",
+            "get_workflow",
+            "get_workflow_version",
+            "get_workflow_tags"
+          ],
+          "required": false
+        },
+        "name": {
+          "type": "string",
+          "description": "Property name"
+        },
+        "type": {
+          "type": "string",
+          "description": "Property type"
+        },
+        "data": {
+          "type": "object",
+          "description": "Credential data (object). Required when creating or changing credential type.",
+          "properties": {}
+        },
+        "isResolvable": {
+          "type": "boolean",
+          "description": "Property isResolvable"
+        },
+        "createdAt": {
+          "type": "string",
+          "description": "Property createdAt"
+        },
+        "updatedAt": {
+          "type": "string",
+          "description": "Property updatedAt"
+        },
+        "isGlobal": {
+          "type": "boolean",
+          "description": "Property isGlobal"
+        },
+        "isPartialData": {
+          "type": "boolean",
+          "description": "Property isPartialData"
+        },
+        "destinationProjectId": {
+          "type": "string",
+          "description": "Property destinationProjectId"
+        },
+        "credentialTypeName": {
+          "type": "string",
+          "description": "The credential type name that you want to get the schema for",
+          "required_for": [
+            "get_credential_schema"
+          ],
+          "required": false
+        },
+        "includeData": {
+          "type": "boolean",
+          "description": "Whether or not to include the execution's detailed data."
+        },
+        "status": {
+          "type": "string",
+          "description": "Status to filter the executions by."
+        },
+        "workflowId": {
+          "type": "string",
+          "description": "Workflow to filter the executions by."
+        },
+        "projectId": {
+          "type": "string",
+          "description": "Parameter projectId"
+        },
+        "limit": {
+          "type": "number",
+          "description": "The maximum number of items to return."
+        },
+        "cursor": {
+          "type": "string",
+          "description": "Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first \"page\" of the collection. See pagination for more detail."
+        },
+        "loadWorkflow": {
+          "type": "boolean",
+          "description": "Property loadWorkflow"
+        },
+        "relations": {
+          "type": "array",
+          "description": "Array of user relations to add: [{ userId, role }]",
+          "items": {
+            "type": "object",
+            "properties": {
+              "userId": {
+                "type": "string"
+              },
+              "role": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user."
+        },
+        "role": {
+          "type": "string",
+          "description": "Property role"
+        },
+        "includeRole": {
+          "type": "boolean",
+          "description": "Whether to include the user's role or not."
+        },
+        "newRoleName": {
+          "type": "string",
+          "description": "Property newRoleName"
+        },
+        "users": {
+          "type": "array",
+          "description": "Array of users to create: [{ email, role }].",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "state": {
+          "type": "string",
+          "description": "Parameter state"
+        },
+        "key": {
+          "type": "string",
+          "description": "Property key"
+        },
+        "value": {
+          "type": "string",
+          "description": "Property value"
+        },
+        "active": {
+          "type": "boolean",
+          "description": "Parameter active"
+        },
+        "tags": {
+          "type": "array",
+          "description": "Workflow tags (array of tag objects). Read-only on create/update; use update_tags action to modify.",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "excludePinnedData": {
+          "type": "boolean",
+          "description": "Set this to avoid retrieving pinned data"
+        },
+        "nodes": {
+          "type": "array",
+          "description": "Workflow nodes array. Each node should follow n8n node schema (id, name, type, typeVersion, position, parameters, etc.).",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "connections": {
+          "type": "object",
+          "description": "Connections map keyed by node name, following n8n workflow schema.",
+          "properties": {}
+        },
+        "settings": {
+          "type": "object",
+          "description": "Workflow settings object (timezone, executionTimeout, etc.).",
+          "properties": {}
+        },
+        "staticData": {
+          "type": "string",
+          "description": "Property staticData"
+        },
+        "shared": {
+          "type": "array",
+          "description": "Property shared",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "activeVersion": {
+          "type": "object",
+          "description": "Property activeVersion",
+          "properties": {}
+        },
+        "versionId": {
+          "type": "string",
+          "description": "The version ID to retrieve",
+          "required_for": [
+            "get_workflow_version"
+          ],
+          "required": false
+        },
+        "description": {
+          "type": "string",
+          "description": "Property description"
+        },
+        "tag_ids": {
+          "type": "array",
+          "description": "Tag IDs to apply to the workflow: [{ id }].",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "action": {
+          "type": "string",
+          "enum": [
+            "get_credential_schema",
+            "list_executions",
+            "get_execution",
+            "list_projects",
+            "list_tags",
+            "get_tag",
+            "list_users",
+            "get_user",
+            "list_variables",
+            "list_workflows",
+            "get_workflow",
+            "get_workflow_version",
+            "get_workflow_tags"
+          ],
+          "description": "Action to perform",
+          "required": true
+        }
+      },
+      "response_fields": {
+        "list_executions": [
+          "data(id,status,mode,startedAt,stoppedAt,workflowId,finished,retryOf,retrySuccessId)",
+          "nextCursor"
+        ],
+        "get_execution": [
+          "id",
+          "status",
+          "mode",
+          "startedAt",
+          "stoppedAt",
+          "workflowId",
+          "finished",
+          "retryOf",
+          "retrySuccessId"
+        ],
+        "list_projects": [
+          "data(id,name,type)",
+          "nextCursor"
+        ],
+        "list_tags": [
+          "data(id,name,createdAt,updatedAt)",
+          "nextCursor"
+        ],
+        "get_tag": [
+          "id",
+          "name",
+          "createdAt",
+          "updatedAt"
+        ],
+        "list_users": [
+          "data(id,email,firstName,lastName,role,isPending)",
+          "nextCursor"
+        ],
+        "get_user": [
+          "id",
+          "email",
+          "firstName",
+          "lastName",
+          "role",
+          "isPending",
+          "createdAt",
+          "updatedAt"
+        ],
+        "list_variables": [
+          "data(id,key,value,type,project(id,name,type))",
+          "nextCursor"
+        ],
+        "list_workflows": [
+          "data(id,name,active,createdAt,updatedAt,tags(id,name),settings(timezone,executionTimeout))",
+          "nextCursor"
+        ],
+        "get_workflow": [
+          "id",
+          "name",
+          "active",
+          "createdAt",
+          "updatedAt",
+          "tags(id,name)",
+          "settings(timezone,executionTimeout)"
+        ],
+        "get_workflow_version": [
+          "versionId",
+          "workflowId",
+          "name",
+          "createdAt",
+          "updatedAt",
+          "authors"
+        ],
+        "get_workflow_tags": [
+          "id",
+          "name",
+          "createdAt",
+          "updatedAt"
+        ]
+      }
+    },
+    {
+      "name": "modify_n8n",
+      "description": "Write access to n8n resources (create/update/delete/activate/deactivate/transfer).",
+      "metadata_params": [
+        "action"
+      ],
+      "operations": {
+        "generate_audit": "post_/audit",
+        "create_credential": "post_/credentials",
+        "update_credential": "updateCredential",
+        "delete_credential": "deleteCredential",
+        "transfer_credential": "put_/credentials/{id}/transfer",
+        "delete_execution": "delete_/executions/{id}",
+        "retry_execution": "post_/executions/{id}/retry",
+        "create_project": "post_/projects",
+        "update_project": "put_/projects/{projectId}",
+        "delete_project": "delete_/projects/{projectId}",
+        "add_project_users": "post_/projects/{projectId}/users",
+        "remove_project_user": "delete_/projects/{projectId}/users/{userId}",
+        "update_project_user_role": "patch_/projects/{projectId}/users/{userId}",
+        "pull_source_control": "post_/source-control/pull",
+        "create_tag": "post_/tags",
+        "update_tag": "put_/tags/{id}",
+        "delete_tag": "delete_/tags/{id}",
+        "create_users": "post_/users",
+        "delete_user": "delete_/users/{id}",
+        "update_user_role": "patch_/users/{id}/role",
+        "create_variable": "post_/variables",
+        "update_variable": "put_/variables/{id}",
+        "delete_variable": "delete_/variables/{id}"
+      },
+      "parameters": {
+        "additionalOptions": {
+          "type": "object",
+          "description": "Property additionalOptions",
+          "properties": {}
+        },
+        "id": {
+          "type": [
+            "string",
+            "number"
+          ],
+          "description": "Property id",
+          "required_for": [
+            "update_credential",
+            "delete_credential",
+            "transfer_credential",
+            "delete_execution",
+            "retry_execution",
+            "update_tag",
+            "delete_tag",
+            "delete_user",
+            "update_user_role",
+            "update_variable",
+            "delete_variable"
+          ],
+          "required": false
+        },
+        "name": {
+          "type": "string",
+          "description": "Property name",
+          "required_for": [
+            "create_credential",
+            "create_project",
+            "update_project",
+            "create_tag",
+            "update_tag"
+          ],
+          "required": false
+        },
+        "type": {
+          "type": "string",
+          "description": "Property type",
+          "required_for": [
+            "create_credential"
+          ],
+          "required": false
+        },
+        "data": {
+          "type": "object",
+          "description": "Credential data (object). Required when creating or changing credential type.",
+          "properties": {},
+          "required_for": [
+            "create_credential"
+          ],
+          "required": false
+        },
+        "isResolvable": {
+          "type": "boolean",
+          "description": "Property isResolvable"
+        },
+        "createdAt": {
+          "type": "string",
+          "description": "Property createdAt"
+        },
+        "updatedAt": {
+          "type": "string",
+          "description": "Property updatedAt"
+        },
+        "isGlobal": {
+          "type": "boolean",
+          "description": "Property isGlobal"
+        },
+        "isPartialData": {
+          "type": "boolean",
+          "description": "Property isPartialData"
+        },
+        "destinationProjectId": {
+          "type": "string",
+          "description": "Property destinationProjectId",
+          "required_for": [
+            "transfer_credential"
+          ],
+          "required": false
+        },
+        "credentialTypeName": {
+          "type": "string",
+          "description": "The credential type name that you want to get the schema for"
+        },
+        "includeData": {
+          "type": "boolean",
+          "description": "Whether or not to include the execution's detailed data."
+        },
+        "status": {
+          "type": "string",
+          "description": "Status to filter the executions by."
+        },
+        "workflowId": {
+          "type": "string",
+          "description": "Workflow to filter the executions by."
+        },
+        "projectId": {
+          "type": "string",
+          "description": "Parameter projectId",
+          "required_for": [
+            "update_project",
+            "delete_project",
+            "add_project_users",
+            "remove_project_user",
+            "update_project_user_role"
+          ],
+          "required": false
+        },
+        "limit": {
+          "type": "number",
+          "description": "The maximum number of items to return."
+        },
+        "cursor": {
+          "type": "string",
+          "description": "Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first \"page\" of the collection. See pagination for more detail."
+        },
+        "loadWorkflow": {
+          "type": "boolean",
+          "description": "Property loadWorkflow"
+        },
+        "relations": {
+          "type": "array",
+          "description": "Array of user relations to add: [{ userId, role }]",
+          "items": {
+            "type": "object",
+            "properties": {
+              "userId": {
+                "type": "string"
+              },
+              "role": {
+                "type": "string"
+              }
+            }
+          },
+          "required_for": [
+            "add_project_users"
+          ],
+          "required": false
+        },
+        "userId": {
+          "type": "string",
+          "description": "The ID of the user.",
+          "required_for": [
+            "remove_project_user",
+            "update_project_user_role"
+          ],
+          "required": false
+        },
+        "role": {
+          "type": "string",
+          "description": "Property role",
+          "required_for": [
+            "update_project_user_role"
+          ],
+          "required": false
+        },
+        "force": {
+          "type": "boolean",
+          "description": "Property force"
+        },
+        "variables": {
+          "type": "object",
+          "description": "Property variables",
+          "properties": {}
+        },
+        "includeRole": {
+          "type": "boolean",
+          "description": "Whether to include the user's role or not."
+        },
+        "newRoleName": {
+          "type": "string",
+          "description": "Property newRoleName",
+          "required_for": [
+            "update_user_role"
+          ],
+          "required": false
+        },
+        "users": {
+          "type": "array",
+          "description": "Array of users to create: [{ email, role }].",
+          "items": {
+            "type": "object",
+            "properties": {}
+          },
+          "required_for": [
+            "create_users"
+          ],
+          "required": false
+        },
+        "state": {
+          "type": "string",
+          "description": "Parameter state"
+        },
+        "key": {
+          "type": "string",
+          "description": "Property key",
+          "required_for": [
+            "create_variable",
+            "update_variable"
+          ],
+          "required": false
+        },
+        "value": {
+          "type": "string",
+          "description": "Property value",
+          "required_for": [
+            "create_variable",
+            "update_variable"
+          ],
+          "required": false
+        },
+        "active": {
+          "type": "boolean",
+          "description": "Parameter active"
+        },
+        "tags": {
+          "type": "array",
+          "description": "Workflow tags (array of tag objects). Read-only on create/update; use update_tags action to modify.",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "excludePinnedData": {
+          "type": "boolean",
+          "description": "Set this to avoid retrieving pinned data"
+        },
+        "staticData": {
+          "type": "string",
+          "description": "Property staticData"
+        },
+        "shared": {
+          "type": "array",
+          "description": "Property shared",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "activeVersion": {
+          "type": "object",
+          "description": "Property activeVersion",
+          "properties": {}
+        },
+        "versionId": {
+          "type": "string",
+          "description": "The version ID to retrieve"
+        },
+        "description": {
+          "type": "string",
+          "description": "Property description"
+        },
+        "action": {
+          "type": "string",
+          "enum": [
+            "generate_audit",
+            "create_credential",
+            "update_credential",
+            "delete_credential",
+            "transfer_credential",
+            "delete_execution",
+            "retry_execution",
+            "create_project",
+            "update_project",
+            "delete_project",
+            "add_project_users",
+            "remove_project_user",
+            "update_project_user_role",
+            "pull_source_control",
+            "create_tag",
+            "update_tag",
+            "delete_tag",
+            "create_users",
+            "delete_user",
+            "update_user_role",
+            "create_variable",
+            "update_variable",
+            "delete_variable"
+          ],
+          "description": "Action to perform",
+          "required": true
+        }
+      },
+      "response_fields": {
+        "generate_audit": [
+          "\"Credentials Risk Report\"",
+          "\"Database Risk Report\"",
+          "\"Nodes Risk Report\"",
+          "\"Filesystem Risk Report\"",
+          "\"Instance Risk Report\""
+        ],
+        "create_credential": [
+          "id",
+          "name",
+          "type",
+          "createdAt",
+          "updatedAt"
+        ],
+        "update_credential": [
+          "id",
+          "name",
+          "type",
+          "createdAt",
+          "updatedAt"
+        ],
+        "delete_credential": [
+          "id",
+          "name",
+          "type",
+          "createdAt",
+          "updatedAt",
+          "isResolvable"
+        ],
+        "delete_execution": [
+          "id",
+          "status",
+          "mode",
+          "startedAt",
+          "stoppedAt",
+          "workflowId",
+          "finished",
+          "retryOf",
+          "retrySuccessId"
+        ],
+        "retry_execution": [
+          "id",
+          "status",
+          "mode",
+          "startedAt",
+          "stoppedAt",
+          "workflowId",
+          "finished",
+          "retryOf",
+          "retrySuccessId"
+        ],
+        "pull_source_control": [
+          "variables(added,changed)",
+          "credentials(id,name,type)",
+          "workflows(id,name)",
+          "tags(tags(id,name),mappings(workflowId,tagId))"
+        ],
+        "create_tag": [
+          "id",
+          "name",
+          "createdAt",
+          "updatedAt"
+        ],
+        "update_tag": [
+          "id",
+          "name",
+          "createdAt",
+          "updatedAt"
+        ],
+        "delete_tag": [
+          "id",
+          "name",
+          "createdAt",
+          "updatedAt"
+        ],
+        "create_users": [
+          "user(id,email,inviteAcceptUrl,emailSent)",
+          "error"
+        ]
+      }
+    },
+    {
+      "name": "modify_n8n_workflows",
+      "description": "Write access to n8n workflows (create/update/delete/activate/deactivate/transfer).",
+      "metadata_params": [
+        "action"
+      ],
+      "operations": {
+        "create_workflow": "post_/workflows",
+        "update_workflow": "put_/workflows/{id}",
+        "delete_workflow": "delete_/workflows/{id}",
+        "activate_workflow": "post_/workflows/{id}/activate",
+        "deactivate_workflow": "post_/workflows/{id}/deactivate",
+        "update_workflow_tags": "put_/workflows/{id}/tags",
+        "transfer_workflow": "put_/workflows/{id}/transfer"
+      },
+      "parameters": {
+        "id": {
+          "type": [
+            "string",
+            "number"
+          ],
+          "description": "Property id",
+          "required_for": [
+            "update_workflow",
+            "delete_workflow",
+            "activate_workflow",
+            "deactivate_workflow",
+            "update_workflow_tags",
+            "transfer_workflow"
+          ],
+          "required": false
+        },
+        "name": {
+          "type": "string",
+          "description": "Property name",
+          "required_for": [
+            "create_workflow",
+            "update_workflow"
+          ],
+          "required": false
+        },
+        "destinationProjectId": {
+          "type": "string",
+          "description": "Property destinationProjectId",
+          "required_for": [
+            "transfer_workflow"
+          ],
+          "required": false
+        },
+        "nodes": {
+          "type": "array",
+          "description": "Workflow nodes array. Each node should follow n8n node schema (id, name, type, typeVersion, position, parameters, etc.).",
+          "items": {
+            "type": "object",
+            "properties": {}
+          },
+          "required_for": [
+            "create_workflow",
+            "update_workflow"
+          ],
+          "required": false
+        },
+        "connections": {
+          "type": "object",
+          "description": "Connections map keyed by node name, following n8n workflow schema.",
+          "properties": {},
+          "required_for": [
+            "create_workflow",
+            "update_workflow"
+          ],
+          "required": false
+        },
+        "settings": {
+          "type": "object",
+          "description": "Workflow settings object (timezone, executionTimeout, etc.).",
+          "properties": {},
+          "required_for": [
+            "create_workflow",
+            "update_workflow"
+          ],
+          "required": false
+        },
+        "staticData": {
+          "type": "string",
+          "description": "Property staticData"
+        },
+        "shared": {
+          "type": "array",
+          "description": "Property shared",
+          "items": {
+            "type": "object",
+            "properties": {}
+          }
+        },
+        "activeVersion": {
+          "type": "object",
+          "description": "Property activeVersion",
+          "properties": {}
+        },
+        "tag_ids": {
+          "type": "array",
+          "description": "Tag IDs to apply to the workflow: [{ id }].",
+          "items": {
+            "type": "object",
+            "properties": {}
+          },
+          "required_for": [
+            "update_workflow_tags"
+          ],
+          "required": false
+        },
+        "action": {
+          "type": "string",
+          "enum": [
+            "create_workflow",
+            "update_workflow",
+            "delete_workflow",
+            "activate_workflow",
+            "deactivate_workflow",
+            "update_workflow_tags",
+            "transfer_workflow"
+          ],
+          "description": "Action to perform",
+          "required": true
+        }
+      },
+      "response_fields": {
+        "create_workflow": [
+          "id",
+          "name",
+          "active",
+          "createdAt",
+          "updatedAt",
+          "tags(id,name)",
+          "settings(timezone,executionTimeout)"
+        ],
+        "update_workflow": [
+          "id",
+          "name",
+          "active",
+          "createdAt",
+          "updatedAt",
+          "tags(id,name)",
+          "settings(timezone,executionTimeout)"
+        ],
+        "delete_workflow": [
+          "id",
+          "name",
+          "active",
+          "createdAt",
+          "updatedAt",
+          "tags(id,name)",
+          "settings(timezone,executionTimeout)"
+        ],
+        "activate_workflow": [
+          "id",
+          "name",
+          "active",
+          "createdAt",
+          "updatedAt",
+          "tags(id,name)",
+          "settings(timezone,executionTimeout)"
+        ],
+        "deactivate_workflow": [
+          "id",
+          "name",
+          "active",
+          "createdAt",
+          "updatedAt",
+          "tags(id,name)",
+          "settings(timezone,executionTimeout)"
+        ],
+        "update_workflow_tags": [
+          "id",
+          "name",
+          "createdAt",
+          "updatedAt"
+        ]
+      }
+    }
+  ],
+  "interceptors": {
+    "auth": {
+      "type": "custom-header",
+      "header_name": "X-N8N-API-KEY",
+      "value_from_env": "N8N_API_TOKEN"
+    },
+    "base_url": {
+      "value_from_env": "N8N_API_BASE_URL",
+      "default": "http://localhost:5678/api/v1"
+    }
+  }
+}