@codemcp/workflows 5.2.4 → 6.0.1

package/resources/state-machine-schema.json

@@ -0,0 +1,114 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "State Machine Definition",
+  "description": "YAML-based state machine definition for Vibe Feature MCP (Simplified Format)",
+  "type": "object",
+  "required": ["name", "description", "initial_state", "states"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Name of the state machine"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the state machine's purpose"
+    },
+    "initial_state": {
+      "type": "string",
+      "description": "The starting state of the machine"
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Enhanced metadata for better discoverability",
+      "properties": {
+        "complexity": {
+          "type": "string",
+          "enum": ["low", "medium", "high"],
+          "description": "Complexity level of the workflow"
+        },
+        "bestFor": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of use cases this workflow is best suited for"
+        },
+        "useCases": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Specific use cases for this workflow"
+        },
+        "examples": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Example scenarios where this workflow would be used"
+        },
+        "requiresDocumentation": {
+          "type": "boolean",
+          "description": "Whether this workflow requires project documentation (architecture, requirements, design) to be set up before starting. Defaults to false for backwards compatibility.",
+          "default": false
+        }
+      }
+    },
+    "states": {
+      "type": "object",
+      "description": "Map of states in the state machine",
+      "additionalProperties": {
+        "$ref": "#/definitions/state"
+      }
+    }
+  },
+  "definitions": {
+    "state": {
+      "type": "object",
+      "required": ["description", "default_instructions", "transitions"],
+      "properties": {
+        "description": {
+          "type": "string",
+          "description": "Description of this state"
+        },
+        "default_instructions": {
+          "type": "string",
+          "description": "Default instructions when entering this state"
+        },
+        "transitions": {
+          "type": "array",
+          "description": "Transitions from this state",
+          "items": {
+            "$ref": "#/definitions/transition"
+          }
+        }
+      }
+    },
+    "transition": {
+      "type": "object",
+      "required": ["trigger", "to", "transition_reason"],
+      "properties": {
+        "trigger": {
+          "type": "string",
+          "description": "Event that triggers this transition"
+        },
+        "to": {
+          "type": "string",
+          "description": "Target state after transition"
+        },
+        "instructions": {
+          "type": "string",
+          "description": "Instructions to provide when this transition occurs (optional - uses target state default if not provided)"
+        },
+        "additional_instructions": {
+          "type": "string",
+          "description": "Additional instructions to combine with target state's default instructions (optional)"
+        },
+        "transition_reason": {
+          "type": "string",
+          "description": "Reason for this transition"
+        }
+      }
+    }
+  }
+}