KAN-73: document and validate MCP ticket description format

2026-10-15 07:06:05 +00:00
parent ca1f243234
commit 5567eea06f
16 changed files with 643 additions and 28 deletions
@@ -0,0 +1,17 @@
+{
+    "format": "Markdown stored verbatim and supported by the Tiptap WYSIWYG editor and ticket detail view.",
+    "supported": "Supported: plain text, paragraphs, line breaks, headings, bold, italic, strikethrough, ordinary ordered/unordered lists (including nested lists), blockquotes, inline/fenced/indented code, horizontal rules, and safe links.",
+    "unsupported": "Not visually supported: task checkboxes, tables, HTML, images, or unsafe links. Newly supplied incompatible descriptions reject the entire mutation with a description field error; existing descriptions are preserved when description is omitted.",
+    "criteria": "Put acceptance criteria exclusively in the structured acceptance_criteria field. Do not repeat them in description as task checkboxes or a copied criteria list. No criteria are automatically extracted or moved.",
+    "links": "Safe link destinations: http://, https://, mailto:, a root-relative path starting with a single /, or a #fragment. Protocol-relative URLs, other schemes, whitespace, control characters, and backslashes (including percent-encoded forms) are not allowed.",
+    "example": "## Goal\n\nExplain the **context** and approach.\n\n- Implement the change\n- Verify [the guide](https://example.com/guide)\n\n> Keep the scope clear.\n\nUse `code` when needed.",
+    "unsupported_tokens": {
+        "html": "HTML",
+        "table": "tables",
+        "image": "images",
+        "task": "task checkboxes",
+        "unsafe_link": "unsafe links"
+    },
+    "link_prefix": "^(?:https?://|mailto:|/(?!/)|#)",
+    "unsafe_link_characters": "[\\s\\\\\\x00-\\x1f\\x7f]"
+}