| generate_mermaid_diagram_fileA | Generate a Mermaid diagram and save it to a local file system directory. SYSTEM PREREQUISITES: Node.js must be installed (v14 or higher) Mermaid CLI must be installed globally: npm install -g @mermaid-js/mermaid-cli The 'mmdc' command must be available in the system PATH Python 3.8 or higher with MCP tools installed
IMPORTANT TRANSPORT & ACCESS REQUIREMENTS: Works with both STDIO and SSE transport modes REQUIRES: The MCP client (e.g., AI assistant) must have access to the local file system where the image is saved The client must have write permissions for the specified folder
PARAMETER GUIDANCE: code: Valid Mermaid diagram syntax (see https://mermaid.js.org/) folder: Absolute or relative path to an existing directory with write permissions name: Filename for the diagram (extension can determine format if format not specified) theme: Theme name for the diagram. MUST be one of: ["default", "neutral", "dark", "forest", "base"] default: Default theme for all diagrams neutral: Great for black and white documents that will be printed dark: Works well with dark-colored elements or dark-mode forest: Contains shades of green base: The only theme that can be modified for customization
backgroundColor: Optional hex color code (e.g., '#FFFFFF') or color name (e.g., 'white', 'transparent') format: Output format. Recommended: "png". Also supports "pdf". "svg" is available but not recommended for general use. If not specified: Inferred from filename extension (e.g., "diagram.png" -> png). Defaults to "png" if no valid extension or format is provided.
RESPONSE: USE CASE:
Best suited for scenarios where: The client needs to persist the diagram to disk The client has local file system access The client needs to reference the image file path in subsequent operations
|
| generate_mermaid_diagram_streamA | Generate a Mermaid diagram and return it directly as a base64-encoded image. SYSTEM PREREQUISITES: Node.js must be installed (v14 or higher) Mermaid CLI must be installed globally: npm install -g @mermaid-js/mermaid-cli The 'mmdc' command must be available in the system PATH Python 3.8 or higher with MCP tools installed MCP client must support SSE transport and binary/base64 image handling
IMPORTANT TRANSPORT REQUIREMENTS: REQUIRES SSE TRANSPORT MODE ONLY Will NOT work with STDIO transport DO NOT use this endpoint if your MCP client doesn't support SSE transport DO NOT use this endpoint if your client can't handle binary/base64 image data
PARAMETER GUIDANCE: code: Valid Mermaid diagram syntax (see https://mermaid.js.org/) theme: Theme name for the diagram. MUST be one of: ["default", "neutral", "dark", "forest", "base"] default: Default theme for all diagrams neutral: Great for black and white documents that will be printed dark: Works well with dark-colored elements or dark-mode forest: Contains shades of green base: The only theme that can be modified for customization
backgroundColor: Optional hex color code (e.g., '#FFFFFF') or color name (e.g., 'white', 'transparent') format: Output format. Recommended: "png". Also supports "pdf". "svg" is available but not recommended. Defaults to "png" if not specified.
RESPONSE: Returns the diagram as a base64-encoded image in the specified format No file system access or permissions required Image data is streamed directly back to the client
USE CASE:
Best suited for scenarios where: The client is using SSE transport mode The client can handle base64-encoded image data No need to persist the image to disk No file system access is available or desired
|