maxsuite Diagrams

Diagrams

Diagrams

Diagrams is where you draw, or write, the pictures that explain a system or a plan: flowcharts, sequences, architecture, charts and the like. A diagram is either a visual canvas you draw on, or a Mermaid diagram written as text and drawn for you. Each keeps its history, its comments and its share links.

In the sidebar under Content → Diagrams. Needs: Projects. A diagram belongs to a project.

Diagrams screen

On the left:

  • a search box;
  • Starters, for people who can manage diagrams: + New canvas for a blank drawing, then + Flowchart, + Sequence, + State machine and + Entity relationship. More templates are available to agents: System architecture, Mindmap, Git graph, Class diagram, and the chart starters Pie chart, Bar chart, Line chart, Gantt chart and Timeline;
  • your diagrams, each with a thumbnail and a VISUAL or MERMAID badge.

On the right, the open diagram:

  • its title, which you edit in place, and its mode;
  • a Mermaid diagram shows its source and the drawing side by side;
  • a visual diagram is a canvas with drawing tools;
  • the buttons Details, History, Comments (with the number of open threads), Share (with the number of live links) and Save;
  • for a visual diagram, also Full screen, Present, PNG and SVG;
  • for a Mermaid diagram, also Open as canvas.

Start a diagram

  1. Open Content → Diagrams.
  2. Click + New canvas to draw, or a starter such as + Flowchart for a Mermaid diagram with example source.
  3. Give it a title, draw or write, and click Save.

There is no project picker. A new diagram goes into the same project as the newest diagram in the list. With no diagrams yet, it is filed under the project id default. An agent can name the project to use.

Turn a Mermaid diagram into a drawing

Click Open as canvas. This makes a second, visual diagram from the Mermaid one and leaves the original alone. Nothing turns a drawing back into Mermaid.

Present or export

  • Full screen shows the board edge to edge with the drawing tools. Present shows the board and nothing else. Press Esc, or click Leave, to come back.
  • PNG and SVG download the drawing.

Go back to an earlier version

  1. Click History. Earlier versions are listed, newest first, each with a short summary of the change and when it was made. A version is kept only when a save changes the drawing or the source, saves by the same person within two minutes count as one, and the list shows the latest 100.
  2. Restore the one you want. The version it replaces is normally kept first, so restoring can itself be undone.

Comment on a diagram

  1. Click Comments.
  2. On a visual diagram, select a shape first to pin the comment to it. Otherwise the comment is about the whole board.
  3. Reply to a thread, resolve it, or reopen it. Click a pinned comment's shape link to show that shape on the board.

Share a diagram outside MaxSuite

  1. Click Share, then + Generate Link. A link made here expires after 30 days.
  2. Copy the link, or copy the embed snippet (an <iframe>) to paste into another website.
  3. Revoke a link to stop it opening the diagram at once.

Anybody holding a live link can view the diagram without signing in. See Sharing and visibility.

Describe or delete a diagram

Details holds a description of what the diagram is for. The title is edited at the top of the diagram instead. Deleting is also in Details. It removes the diagram with its history, comments and share links, and cannot be undone. Whoever made it, someone who edits its project, or an administrator may delete it.

Search in the top bar also finds diagrams, and opens only the ones you may open.

Who can do what

PermissionLabelLets you
diagrams:readView diagramsSee diagrams, their history and share links. Comment, reply, resolve threads and delete your own comments.
diagrams:writeManage diagramsCreate, edit, restore, share, revoke links and delete diagrams. Delete anybody's comments.

See People, roles and permissions.

What happens on its own

Nothing in this module runs on a schedule.

What agents can do

An agent can list, read, create and edit diagrams, write Mermaid, draw charts from the chart starters, and join the comment threads. Reads run straight away. Changes wait for a person's approval by default (Agents and approvals).

Read only: diagrams.list, diagrams.get, diagrams.versions, diagrams.version, diagrams.comments, diagrams.shareLinks, diagrams.templates

Write: diagrams.create, diagrams.update, diagrams.restoreVersion, diagrams.unshare

Comment: diagrams.comment, diagrams.resolveComment, diagrams.removeComment (cannot be undone)

Reaches outside: diagrams.share makes a public link, so anybody holding it can read the diagram.

Delete (cannot be undone): diagrams.remove

diagrams.shareLinks gives ids and expiry dates only, never the link itself. Over MCP the same tools are named diagrams__list, diagrams__create and so on. See API keys and MCP access.