MERMAID MCP Tools

Total Tools: 3

Quick Reference

# List all mermaid tools
dmtools list | jq '.tools[] | select(.name | startswith("mermaid_"))'

# Example usage
dmtools mermaid_index_generate [arguments]

Usage in JavaScript Agents

// Direct function calls for mermaid tools
const result = mermaid_index_generate(...);
const result = mermaid_index_read_list(...);
const result = mermaid_index_read(...);

Available Tools

Detailed Parameter Information

mermaid_index_generate

Generate Mermaid diagrams from content sources (Confluence or Jira) based on include/exclude patterns. Processes content recursively and stores diagrams in hierarchical file structure.

Parameters:

• integration (string) Required

  • Integration type: ‘confluence’, ‘jira’, ‘jira_xray’, or ‘testrail’
  • Example: confluence

• include_patterns (array) Required

  • Array of include patterns. For Confluence: [“SPACE/pages/PAGE_ID/PAGE_NAME/**”]. For Jira: [“JQL query”]. For TestRail: [“project_id=5&suite_id=3”]
  • Example: ["AINA/pages/11665522/Templates/**"]

• exclude_patterns (array) Optional

  • Optional array of exclude patterns to filter out specific content (not used for Jira)
  • Example: []

• storage_path (string) Required

  • Base path for storing generated diagrams
  • Example: ./mermaid-diagrams

• custom_fields (array) Optional

  • Optional array of custom field names to include in content (only for Jira integrations)
  • Example: ["summary", "description", "customfield_10001"]

• include_comments (boolean) Optional

  • Whether to include comments in content (only for Jira integrations, default: false)
  • Example: false

Example:

dmtools mermaid_index_generate "value" "value"

// In JavaScript agent
const result = mermaid_index_generate("integration", "include_patterns");

mermaid_index_read

Read all Mermaid diagram files (.mmd) from storage path recursively. Returns list of diagrams with their paths and content.

Parameters:

• integration (string) Required

  • Integration type (used as subfolder name under storage path)
  • Example: confluence

• storage_path (string) Required

  • Base path where diagrams are stored
  • Example: ./mermaid-diagrams

Example:

dmtools mermaid_index_read "value" "value"

// In JavaScript agent
const result = mermaid_index_read("integration", "storage_path");

mermaid_index_read_list

Read all Mermaid diagram files (.mmd) from storage path recursively. Returns list of ToText objects with paths and content.

Parameters:

• integration (string) Required

  • Integration type (used as subfolder name under storage path)
  • Example: confluence

• storage_path (string) Required

  • Base path where diagrams are stored
  • Example: ./mermaid-diagrams

Example:

dmtools mermaid_index_read_list "value" "value"

// In JavaScript agent
const result = mermaid_index_read_list("integration", "storage_path");