-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplugin.json
More file actions
89 lines (89 loc) · 14.3 KB
/
Copy pathplugin.json
File metadata and controls
89 lines (89 loc) · 14.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
"id": "render_mermaid_diagram",
"org": "satware AG",
"emoji": "\uD83E\uDDDC\u200D♀\uFE0F",
"title": "satware® AI Mermaid",
"output": "render_html",
"system": false,
"context": {
"name": "mermaid-diagram-requirements",
"type": "static",
"content": "# Mermaid.js v11 – Diagram Syntax Requirements\n\n**IMPORTANT: These are STRICT REQUIREMENTS. Syntax deviations WILL cause rendering failures.**\n\n## 1. Supported Diagram Types\n\n| Type | Prefix (REQUIRED) | Use Case |\n|------|-------------------|----------|\n| Flowchart | `flowchart TD/LR` | Process flows, logic |\n| Sequence | `sequenceDiagram` | Interactions/timing |\n| Gantt | `gantt` | Project timelines |\n| Class | `classDiagram` | UML class structures |\n| Gitgraph | `gitGraph` | Git branching/history |\n| Entity Relationship | `erDiagram` | Database relationships |\n| User Journey | `journey` | Experience mapping |\n| Quadrant Chart | `quadrantChart` | Prioritization matrices |\n| Pie Chart | `pie` | Proportional data |\n| Timeline | `timeline` | Chronological events |\n| Mindmap | `mindmap` | Hierarchical concepts |\n\n**Experimental/Beta Types (EXACT PREFIX REQUIRED):**\n- Block Diagram: `block-beta`\n- Architecture: `architecture-beta`\n- Radar Chart: `radar-beta`\n- XY Chart: `xychart-beta`\n- Sankey: `sankey-beta`\n- Packet: `packet-beta`\n\n## 2. REQUIRED Syntax Principles\n\n- **Prefix:** MUST start with the exact diagram type.\n- **Labels:** MUST use double quotes for spaces/special chars: `node1[\"Label with spaces\"]`\n- **Multiline labels:** Use line breaks inside quotes.\n- **Markdown in labels:** Use backticks inside double quotes: `markdown[\"\\`This **is** _Markdown_\\`\"]`\n- **NO HTML tags** in node definitions.\n- **Styling:** Use style/classDef after nodes/connections: `style NodeName fill:#color,stroke:#color;`\n- **Comments:** Start with `%%`\n\n## 3. Diagram-Specific Rules\n\n### XY Chart (`xychart-beta`)\n```\nxychart-beta\n title \"Sales Performance\"\n x-axis [Jan, Feb, Mar]\n y-axis \"Revenue (USD)\" 4000 --> 7000\n bar [5000, 6000, 6500]\n line [4500, 5500, 6200]\n```\n\n### Sankey Diagram (`sankey-beta`)\n```\nsankey-beta\nSourceA,TargetA,10\nSourceA,TargetB,5\nTargetA,FinalNode,8\n```\n**Rules:**\n- Data lines MUST immediately follow `sankey-beta` keyword\n- Strict CSV format: `source,target,value`\n- NO circular flows\n- Values MUST be positive integers\n- Commas in labels: wrap in double quotes\n\n### Packet Diagram (`packet-beta`)\n```\npacket-beta\n0-15: \"Source Port\"\n16-31: \"Destination Port\"\n32-63: \"Sequence Number\"\n```\n\n### Block Diagram (`block-beta`)\n```\nblock-beta\ncolumns 3\nClient[\"Client\"] API[\"API\"] space\nspace Service[\"Service\"] space\nDB[\"Database\"] Cache[\"Cache\"] Logger[\"Logger\"]\n\nClient --> API\nAPI --> Service\nService --> DB\n\nstyle DB fill:#f9f9f9,color:#333;\n```\n**Rules:**\n1. Use `ID[\"Display Text\"]` for blocks\n2. Arrows DO NOT support labels\n3. Connections/styles after grid layout\n4. Use `space` for empty cells\n\n## 4. Flowchart Shapes & Links\n\n**Shapes:**\n```\nid[Text] # Rectangle\nid((Text)) # Circle\nid(((Text))) # Double circle\nid[(Text)] # Cylinder/db\nid{Text} # Diamond/rhombus\nid[/Text/] # Parallelogram\n```\n\n**Links:**\n```\nA-->B # Arrow\nA---B # Open line\nA-.->B # Dotted arrow\nA==>B # Thick arrow\nA<<-->>B # Bidirectional\nA~~~B # Invisible link\nA-->|\"text\"|B # Arrow with label\n```\n\n## 5. Verification Checklist\n\n### All diagrams:\n- [ ] Correct prefix\n- [ ] Unique IDs\n- [ ] Proper quoting\n- [ ] No cycles (unless allowed)\n\n### Flowcharts:\n- [ ] Direction set (TD/LR/etc.)\n- [ ] Bracketed shapes\n- [ ] Valid connections\n\n### Sankey:\n- [ ] Data immediately after prefix\n- [ ] Strict CSV format\n- [ ] Positive integer values\n\n### Block-beta:\n- [ ] Columns set first\n- [ ] No labels on arrows\n- [ ] Connections after grid\n\n## Common Failures\n\n| Violation | Result |\n|-----------|--------|\n| Missing/wrong prefix | Complete failure |\n| Incorrect quoting | Syntax errors |\n| Circular references | \"Circular link\" errors |\n| HTML in nodes | Parsing errors |\n| Labels on block-beta arrows | Lexical error |\n| Sankey data not after prefix | Parse error |"
},
"iconURL": "https://cdn.jsdelivr.net/gh/twitter/twemoji@14.0.2/assets/svg/1f9dc-200d-2640-fe0f.svg",
"version": 1,
"disabled": false,
"syncedAt": null,
"githubURL": "https://github.com/satwareAG/mermaid-plugin",
"openaiSpec": {
"name": "render_mermaid_diagram",
"parameters": {
"type": "object",
"required": [
"title",
"source"
],
"properties": {
"title": {
"type": "string",
"description": "The title of the diagram."
},
"source": {
"type": "string",
"description": "The Mermaid diagram source in raw text to render."
}
}
},
"description": "Generate a diagram using Mermaid."
},
"outputType": "render_html",
"oauthConfig": null,
"permissions": [],
"userSettings": null,
"isServerPlugin": true,
"pluginFunctions": [
{
"id": "LEGACY_DEFAULT_FUNCTION",
"name": "render_mermaid_diagram",
"openaiSpec": {
"name": "render_mermaid_diagram",
"parameters": {
"type": "object",
"required": [
"title",
"source"
],
"properties": {
"title": {
"type": "string",
"description": "The title of the diagram."
},
"source": {
"type": "string",
"description": "The Mermaid diagram source in raw text to render."
}
}
},
"description": "Generate a diagram using Mermaid."
},
"outputType": "render_html",
"implementationType": "javascript"
}
],
"overviewMarkdown": "# Mermaid.js v11 – Diagram Syntax Requirements\n\n**IMPORTANT: These are STRICT REQUIREMENTS. Syntax deviations WILL cause rendering failures.**\n\n## 1. Supported Diagram Types\n\n| Type | Prefix (REQUIRED) | Use Case |\n|------|-------------------|----------|\n| Flowchart | `flowchart TD/LR` | Process flows, logic |\n| Sequence | `sequenceDiagram` | Interactions/timing |\n| Gantt | `gantt` | Project timelines |\n| Class | `classDiagram` | UML class structures |\n| Gitgraph | `gitGraph` | Git branching/history |\n| Entity Relationship | `erDiagram` | Database relationships |\n| User Journey | `journey` | Experience mapping |\n| Quadrant Chart | `quadrantChart` | Prioritization matrices |\n| Pie Chart | `pie` | Proportional data |\n| Timeline | `timeline` | Chronological events |\n| Mindmap | `mindmap` | Hierarchical concepts |\n\n**Experimental/Beta Types (EXACT PREFIX REQUIRED):**\n- Block Diagram: `block-beta`\n- Architecture: `architecture-beta`\n- Radar Chart: `radar-beta`\n- XY Chart: `xychart-beta`\n- Sankey: `sankey-beta`\n- Packet: `packet-beta`\n\n## 2. REQUIRED Syntax Principles\n\n- **Prefix:** MUST start with the exact diagram type.\n- **Labels:** MUST use double quotes for spaces/special chars: `node1[\"Label with spaces\"]`\n- **Multiline labels:** Use line breaks inside quotes.\n- **Markdown in labels:** Use backticks inside double quotes: `markdown[\"\\`This **is** _Markdown_\\`\"]`\n- **NO HTML tags** in node definitions.\n- **Styling:** Use style/classDef after nodes/connections: `style NodeName fill:#color,stroke:#color;`\n- **Comments:** Start with `%%`\n\n## 3. Diagram-Specific Rules\n\n### XY Chart (`xychart-beta`)\n```\nxychart-beta\n title \"Sales Performance\"\n x-axis [Jan, Feb, Mar]\n y-axis \"Revenue (USD)\" 4000 --> 7000\n bar [5000, 6000, 6500]\n line [4500, 5500, 6200]\n```\n\n### Sankey Diagram (`sankey-beta`)\n```\nsankey-beta\nSourceA,TargetA,10\nSourceA,TargetB,5\nTargetA,FinalNode,8\n```\n**Rules:**\n- Data lines MUST immediately follow `sankey-beta` keyword\n- Strict CSV format: `source,target,value`\n- NO circular flows\n- Values MUST be positive integers\n- Commas in labels: wrap in double quotes\n\n### Packet Diagram (`packet-beta`)\n```\npacket-beta\n0-15: \"Source Port\"\n16-31: \"Destination Port\"\n32-63: \"Sequence Number\"\n```\n\n### Block Diagram (`block-beta`)\n```\nblock-beta\ncolumns 3\nClient[\"Client\"] API[\"API\"] space\nspace Service[\"Service\"] space\nDB[\"Database\"] Cache[\"Cache\"] Logger[\"Logger\"]\n\nClient --> API\nAPI --> Service\nService --> DB\n\nstyle DB fill:#f9f9f9,color:#333;\n```\n**Rules:**\n1. Use `ID[\"Display Text\"]` for blocks\n2. Arrows DO NOT support labels\n3. Connections/styles after grid layout\n4. Use `space` for empty cells\n\n## 4. Flowchart Shapes & Links\n\n**Shapes:**\n```\nid[Text] # Rectangle\nid((Text)) # Circle\nid(((Text))) # Double circle\nid[(Text)] # Cylinder/db\nid{Text} # Diamond/rhombus\nid[/Text/] # Parallelogram\n```\n\n**Links:**\n```\nA-->B # Arrow\nA---B # Open line\nA-.->B # Dotted arrow\nA==>B # Thick arrow\nA<<-->>B # Bidirectional\nA~~~B # Invisible link\nA-->|\"text\"|B # Arrow with label\n```\n\n## 5. Verification Checklist\n\n### All diagrams:\n- [ ] Correct prefix\n- [ ] Unique IDs\n- [ ] Proper quoting\n- [ ] No cycles (unless allowed)\n\n### Flowcharts:\n- [ ] Direction set (TD/LR/etc.)\n- [ ] Bracketed shapes\n- [ ] Valid connections\n\n### Sankey:\n- [ ] Data immediately after prefix\n- [ ] Strict CSV format\n- [ ] Positive integer values\n\n### Block-beta:\n- [ ] Columns set first\n- [ ] No labels on arrows\n- [ ] Connections after grid\n\n## Common Failures\n\n| Violation | Result |\n|-----------|--------|\n| Missing/wrong prefix | Complete failure |\n| Incorrect quoting | Syntax errors |\n| Circular references | \"Circular link\" errors |\n| HTML in nodes | Parsing errors |\n| Labels on block-beta arrows | Lexical error |\n| Sankey data not after prefix | Parse error |",
"authenticationType": "AUTH_TYPE_NONE",
"implementationType": "javascript",
"dynamicContextEndpoints": [
{
"id": "5d662c98-599e-4afd-b5a2-af052b353c78",
"url": "",
"name": "mermaid-diagram-requirements",
"method": "GET",
"source": "static",
"staticContent": "# Mermaid.js v11 – Diagram Syntax Requirements\n\n**IMPORTANT: These are STRICT REQUIREMENTS. Syntax deviations WILL cause rendering failures.**\n\n## 1. Supported Diagram Types\n\n| Type | Prefix (REQUIRED) | Use Case |\n|------|-------------------|----------|\n| Flowchart | `flowchart TD/LR` | Process flows, logic |\n| Sequence | `sequenceDiagram` | Interactions/timing |\n| Gantt | `gantt` | Project timelines |\n| Class | `classDiagram` | UML class structures |\n| Gitgraph | `gitGraph` | Git branching/history |\n| Entity Relationship | `erDiagram` | Database relationships |\n| User Journey | `journey` | Experience mapping |\n| Quadrant Chart | `quadrantChart` | Prioritization matrices |\n| Pie Chart | `pie` | Proportional data |\n| Timeline | `timeline` | Chronological events |\n| Mindmap | `mindmap` | Hierarchical concepts |\n\n**Experimental/Beta Types (EXACT PREFIX REQUIRED):**\n- Block Diagram: `block-beta`\n- Architecture: `architecture-beta`\n- Radar Chart: `radar-beta`\n- XY Chart: `xychart-beta`\n- Sankey: `sankey-beta`\n- Packet: `packet-beta`\n\n## 2. REQUIRED Syntax Principles\n\n- **Prefix:** MUST start with the exact diagram type.\n- **Labels:** MUST use double quotes for spaces/special chars: `node1[\"Label with spaces\"]`\n- **Multiline labels:** Use line breaks inside quotes.\n- **Markdown in labels:** Use backticks inside double quotes: `markdown[\"\\`This **is** _Markdown_\\`\"]`\n- **NO HTML tags** in node definitions.\n- **Styling:** Use style/classDef after nodes/connections: `style NodeName fill:#color,stroke:#color;`\n- **Comments:** Start with `%%`\n\n## 3. Diagram-Specific Rules\n\n### XY Chart (`xychart-beta`)\n```\nxychart-beta\n title \"Sales Performance\"\n x-axis [Jan, Feb, Mar]\n y-axis \"Revenue (USD)\" 4000 --> 7000\n bar [5000, 6000, 6500]\n line [4500, 5500, 6200]\n```\n\n### Sankey Diagram (`sankey-beta`)\n```\nsankey-beta\nSourceA,TargetA,10\nSourceA,TargetB,5\nTargetA,FinalNode,8\n```\n**Rules:**\n- Data lines MUST immediately follow `sankey-beta` keyword\n- Strict CSV format: `source,target,value`\n- NO circular flows\n- Values MUST be positive integers\n- Commas in labels: wrap in double quotes\n\n### Packet Diagram (`packet-beta`)\n```\npacket-beta\n0-15: \"Source Port\"\n16-31: \"Destination Port\"\n32-63: \"Sequence Number\"\n```\n\n### Block Diagram (`block-beta`)\n```\nblock-beta\ncolumns 3\nClient[\"Client\"] API[\"API\"] space\nspace Service[\"Service\"] space\nDB[\"Database\"] Cache[\"Cache\"] Logger[\"Logger\"]\n\nClient --> API\nAPI --> Service\nService --> DB\n\nstyle DB fill:#f9f9f9,color:#333;\n```\n**Rules:**\n1. Use `ID[\"Display Text\"]` for blocks\n2. Arrows DO NOT support labels\n3. Connections/styles after grid layout\n4. Use `space` for empty cells\n\n## 4. Flowchart Shapes & Links\n\n**Shapes:**\n```\nid[Text] # Rectangle\nid((Text)) # Circle\nid(((Text))) # Double circle\nid[(Text)] # Cylinder/db\nid{Text} # Diamond/rhombus\nid[/Text/] # Parallelogram\n```\n\n**Links:**\n```\nA-->B # Arrow\nA---B # Open line\nA-.->B # Dotted arrow\nA==>B # Thick arrow\nA<<-->>B # Bidirectional\nA~~~B # Invisible link\nA-->|\"text\"|B # Arrow with label\n```\n\n## 5. Verification Checklist\n\n### All diagrams:\n- [ ] Correct prefix\n- [ ] Unique IDs\n- [ ] Proper quoting\n- [ ] No cycles (unless allowed)\n\n### Flowcharts:\n- [ ] Direction set (TD/LR/etc.)\n- [ ] Bracketed shapes\n- [ ] Valid connections\n\n### Sankey:\n- [ ] Data immediately after prefix\n- [ ] Strict CSV format\n- [ ] Positive integer values\n\n### Block-beta:\n- [ ] Columns set first\n- [ ] No labels on arrows\n- [ ] Connections after grid\n\n## Common Failures\n\n| Violation | Result |\n|-----------|--------|\n| Missing/wrong prefix | Complete failure |\n| Incorrect quoting | Syntax errors |\n| Circular references | \"Circular link\" errors |\n| HTML in nodes | Parsing errors |\n| Labels on block-beta arrows | Lexical error |\n| Sankey data not after prefix | Parse error |",
"cacheDurationHours": 1,
"cacheRefreshPolicy": "REFRESH_NEVER"
}
],
"sharedOAuthConnectionID": null
}