# Plotwork documentation > A small text language and renderer for twenty kinds of diagram, from flow, sequence, and database to Gantt, state, mind map, and treemap, written by AI agents and drawn the same way everywhere: in a README, in your editor, and over MCP. Every page below is a Markdown file. The address of any page on this site, with `.md` added, returns that page as Markdown with its links already pointing at other Markdown pages, so an agent can follow them without a browser. Sizes are rough token counts. To read a whole subject, fetch the bundle of its tab (`llms-.txt`, listed under Machine-readable files) rather than the whole documentation. Pages marked optional are catalogues and policies: read them only when the task needs them. ## Documentation: Get started - [Quick start](https://docs.plotwork.dev/quick-start.md): Connect an AI agent, ask it for a diagram in plain words, and have a checked picture in about five minutes. (3.1k tokens) - [Examples to copy](https://docs.plotwork.dev/examples.md): Eight finished diagrams with the text that makes each one and the prompt that gets an agent to write it. Copy the text into a diagram fence, or paste the prompt into your agent and change the names to yours. (4.7k tokens) - [Writing diagrams](https://docs.plotwork.dev/writing-diagrams.md): How to write flow, sequence, and schema diagrams in the diagram language, with a pointer to the guide of each of the seventeen other kinds. There are twenty kinds in all. It is for anyone, human or AI agent, who writes diagram source. (7.6k tokens) - [Diagrams in Markdown and on GitHub](https://docs.plotwork.dev/markdown-and-github.md): How a diagram fence in a Markdown file becomes a picture that GitHub displays, and how to keep it current. It is for anyone adding diagrams to a README or a doc. (2.1k tokens) - [Keep diagrams in sync in CI](https://docs.plotwork.dev/diagrams-in-ci.md): How to fail a pull request whose diagram pictures no longer match their source, with the GitHub Action or the command line. It is for anyone who keeps Plotwork diagrams in Markdown or .diagram files in a repository. (3.1k tokens) - [Diagrams as code](https://docs.plotwork.dev/diagrams-as-code.md): Make diagrams from the files they describe (Terraform, OpenAPI, Docker Compose, Kubernetes, Helm, Kustomize, the AWS CDK, Backstage catalogs, Structurizr workspaces, AsyncAPI documents, Prisma, Drizzle, SQL, GitHub Actions, GitLab CI/CD, and Azure Pipelines pipelines, CSV and JSON, folder listings, and git logs) and keep them in step: a pull request whose diagrams no longer match fails, and a workflow writes them again. (5.9k tokens) - [Enterprise rollout](https://docs.plotwork.dev/enterprise-rollout.md): How a platform team puts diagrams as code into hundreds of repositories: one reusable workflow, a required status check, owners for the overrides files, pinned and updated releases, self-hosted runners and GitHub Enterprise Server, an air-gapped setup, and the outputs other tools read. (3.2k tokens) - [Diagram evidence for audits](https://docs.plotwork.dev/diagram-evidence-for-audits.md): How to keep the network, system and data-flow diagrams an auditor asks for current between audits, and what to hand over when the auditor asks. (2.3k tokens) - [Slack, email, Confluence, and Notion](https://docs.plotwork.dev/wikis-and-chat.md): How to put a Plotwork diagram where a picture is wanted outside a repository: a PNG for a chat or an email, and paste-ready text for Confluence and Notion. Nothing here needs an account with those services, a token, or a paid API. (1.5k tokens) - [Viewing diagrams](https://docs.plotwork.dev/viewing-diagrams.md): Where you see a diagram an agent drew, in each place you work with an agent, and what is sent where when you do. An agent reads the check and the outline; you want the picture. (3.7k tokens) - [Editing an existing diagram](https://docs.plotwork.dev/editing-existing-diagrams.md): How an agent, or you, changes a diagram that already exists as a Plotwork picture: a hosted link, an .svg file in a repository, or a diagram fence in a Markdown file. (2.5k tokens) - [Migrating from Mermaid](https://docs.plotwork.dev/migrating-from-mermaid.md): How to move existing Mermaid diagrams to Plotwork with a converter that is deterministic, and how an AI agent finishes the job. It is written for the agent first: every step names the tool to call and what the result means. (16.0k tokens) - [Importing from code and data](https://docs.plotwork.dev/importing-from-code-and-data.md): import_source turns a file you already have into a finished diagram in one call: a database schema, an API specification, infrastructure code, a container setup, a CI workflow, a table of numbers, a folder listing, or a git log. (15.0k tokens) - [How a diagram is drawn](https://docs.plotwork.dev/how-it-works.md): What happens to a diagram between the text you write and the picture you see: it is checked, laid out, drawn, described, and placed in your document. (1.5k tokens) ## Documentation: Hosted diagrams and plans - [Hosted diagrams](https://docs.plotwork.dev/hosted-diagrams.md): Publish a diagram and get a public link to its picture for a README, a pull request or a chat. It works over MCP (Model Context Protocol) and over REST. (7.1k tokens) - [Organisations](https://docs.plotwork.dev/organisations.md): Share a private library of diagrams with a team. An organisation is a named group of accounts. Its members publish to one library that only they can open, by hand in the portal or from an agent. (11.8k tokens) - [Brand themes](https://docs.plotwork.dev/brand-themes.md): Paint every diagram the hosted service draws for your organisation in your company's colors. An owner or admin sets one to three colors in the portal, and the hosted MCP server, the REST API and publishing use them from then on. (1.6k tokens) - [Custom icons](https://docs.plotwork.dev/custom-icons.md): Upload your company's own service logos to an organisation, and the hosted service draws them in your diagrams as icon=org:. Icon search, map_icons and automatic icon matching find them by name and by alias. (1.7k tokens) - [Audit log](https://docs.plotwork.dev/audit-log.md): An organisation's audit log says who changed what in the organisation, and when. The owner and the admins read it in the portal, and on Enterprise they export it, or have their SIEM poll it with a key that can do nothing else. (2.1k tokens) - [Send audit events and drift to your tools](https://docs.plotwork.dev/siem-delivery.md): On Enterprise, an organisation can send every event of its audit log, and every drift run its CI reports, to the tools it already runs: Datadog, Dynatrace, Splunk, Microsoft Sentinel, or an HTTPS webhook of its own. (3.7k tokens) - [Single sign-on](https://docs.plotwork.dev/single-sign-on.md): An Enterprise organisation can sign its members in through its own identity provider with OpenID Connect or SAML 2.0. (3.4k tokens) - [Single sign-on with Okta](https://docs.plotwork.dev/single-sign-on-okta.md): Connect an Enterprise organisation to Okta with OpenID Connect or SAML 2.0. Prove your email domain in Plotwork first, as the single sign-on guide describes. (1.7k tokens) - [Single sign-on with Microsoft Entra ID](https://docs.plotwork.dev/single-sign-on-entra-id.md): Connect an Enterprise organisation to Microsoft Entra ID (formerly Azure Active Directory) with OpenID Connect or SAML 2.0. Prove your email domain in Plotwork first, as the single sign-on guide describes. (2.0k tokens) - [Single sign-on with Google Workspace](https://docs.plotwork.dev/single-sign-on-google-workspace.md): Connect an Enterprise organisation to Google Workspace with OpenID Connect or SAML 2.0. Prove your email domain in Plotwork first, as the single sign-on guide describes. (1.3k tokens) - [The drift dashboard](https://docs.plotwork.dev/drift-dashboard.md): The drift dashboard shows, in one place, which diagrams across an organisation's repositories still match the files they are drawn from. (1.8k tokens) - [Repository settings](https://docs.plotwork.dev/repository-settings.md): Keep how your team draws in one file, plotwork.config.json, at the root of the repository: defaults for the header options a diagram leaves out, style rules that CI enforces, the organisation whose brand hosted calls use, and the diagrams made from files of the repository. (2.9k tokens) - [Enterprise support](https://docs.plotwork.dev/enterprise-support.md): An organisation on an Enterprise contract has priority support: a named person at Plotwork who answers it, a first response target in business hours, and the hours support is staffed. (1.5k tokens) - [Plans and billing](https://docs.plotwork.dev/plans-and-billing.md): See what Free and Pro include, how to upgrade and cancel, and what the daily call limit does when you reach it. (3.1k tokens) ## Documentation: Cloud architecture - [Cloud architecture](https://docs.plotwork.dev/cloud-architecture.md): How to draw an AWS, Azure, or Google Cloud architecture that reads like a cloud architecture: typed groups for accounts, regions, and networks, a product icon on every service, and technology marks where they help. (2.6k tokens) - [Group types](https://docs.plotwork.dev/cloud-architecture/group-types.md): The closed list of type= values a group can take, each drawn by the renderer as it appears in a diagram, with the frame and tone it uses and the icon it draws for each provider. (2.7k tokens) - [Frames, tones, lines, and symbols](https://docs.plotwork.dev/cloud-architecture/lines-and-symbols.md): Every frame style, tone, edge style, arrowhead, label, and mark the language draws, each shown as the renderer draws it, with the exact source that makes it. (2.9k tokens) - [Icon names and lookup](https://docs.plotwork.dev/cloud-architecture/icon-names.md): How a cloud product becomes an icon= name, how search finds it, and how to map the product names in a request to icons with the tools. It is for an AI agent first; a person can use the icon pages in the same way. (2.2k tokens) - [Marks, second lines, and overlays](https://docs.plotwork.dev/cloud-architecture/marks-and-overlays.md): How to put technology marks on a service, a second line and marks on a group tab, an overlay around a set that spans zones, and a dotted line for an event. It is for anyone drawing a cloud architecture, human or AI agent. (1.4k tokens) - [Cloud architecture examples](https://docs.plotwork.dev/cloud-architecture/examples.md): Three complete cloud diagrams, one for each of Azure, AWS, and Google Cloud, each drawn from a checked pattern. It is for anyone who wants to read a finished diagram before writing one, human or AI agent. (3.1k tokens) - [Architecture gallery](https://docs.plotwork.dev/cloud-architecture/gallery.md): Five full-size cloud and network architectures drawn in Plotwork, with the text that makes each one and the prompt that gets an agent to write something like it. (10.2k tokens) ## AI agents: For agents - [Plotwork for AI agents](https://docs.plotwork.dev/agents/overview.md): How an AI agent finds, reads, and uses Plotwork: the files it can read without connecting, the ways to call the tools, and the loop that gets a valid diagram. (3.5k tokens) - [llms.txt and Markdown pages](https://docs.plotwork.dev/agents/machine-readable.md): The files that let an agent read these docs without a browser: an index, the full text, a Markdown copy of every page, and the generated references as data. (1.6k tokens) - [The Claude Code plugin](https://docs.plotwork.dev/agents/claude-code-plugin.md): The Plotwork plugin for Claude Code joins the MCP server and the command line, so a diagram you ask for ends up as an SVG in your docs with no step of your own. It is for anyone who uses Claude Code in a repository with documentation. (4.1k tokens) - [Rules file for your agent](https://docs.plotwork.dev/agents/rules.md): A block to paste into CLAUDE.md, AGENTS.md, or an editor rules file so an agent draws diagrams with the Plotwork tools in the right order. It is the same guidance the MCP server sends when a client connects. (2.6k tokens) - [Prompts and recipes](https://docs.plotwork.dev/agents/prompts.md): Requests that work well, the tool an agent calls for each, and the jobs an agent is most often given with the calls that do them. (2.9k tokens) ## MCP: Use the server - [MCP server](https://docs.plotwork.dev/mcp/overview.md): What the diagram MCP (Model Context Protocol) server is, which tools it exposes, and how it behaves. It is for anyone who wants an AI agent to write, check, and render diagrams. (3.6k tokens) - [Connecting an agent](https://docs.plotwork.dev/mcp/connect.md): How to connect an AI agent or an editor to the diagram tools over MCP (Model Context Protocol). It is for anyone setting up Claude Code, Cursor, VS Code, Claude Desktop, or another MCP client. (3.9k tokens) - [Writing diagrams with an agent](https://docs.plotwork.dev/mcp/agent-loop.md): The loop an AI agent follows to produce a correct diagram: read the language once, write source, validate until clean, check the meaning, render. It is for people who connect an agent to the diagram tools, and for the prompt an agent reads. (4.6k tokens) - [Local usage counts and sharing](https://docs.plotwork.dev/mcp/usage.md): Count how you use the local MCP server on your own machine, and choose whether to share pseudonymous daily totals with Plotwork. Both are off by default. (1.8k tokens) - [Self-hosting the engine](https://docs.plotwork.dev/mcp/self-hosting.md): Run the Plotwork engine inside your own network as one container: the MCP tools for your agents and the REST drawing routes for your services, with no account and no request leaving your network. (2.4k tokens) - [Use Plotwork with open and self-hosted models](https://docs.plotwork.dev/mcp/open-models.md): How to run Plotwork's MCP tools with an open model, such as gpt-oss, Qwen, Gemma, or Llama, served by Ollama, LM Studio, vLLM, or llama.cpp, through an MCP client such as Goose, Cline, Continue, or the OpenAI Agents SDK. (3.5k tokens) ## MCP: Tool reference - [Tool reference](https://docs.plotwork.dev/mcp/tools.md): The operations an AI agent can call. Each tool has a name, a description written for a model, typed arguments, and a typed result, and its own page. (3.4k tokens) ## MCP: Workflows - [draw_diagram](https://docs.plotwork.dev/mcp/tools/draw-diagram.md): Checks, describes, and draws a diagram. It is a workflow of the MCP server and the HTTP API, with the title "Draw diagram". (3.9k tokens) - [edit_diagram](https://docs.plotwork.dev/mcp/tools/edit-diagram.md): Changes diagram source with typed operations, on every kind, and checks the result. It is a workflow of the MCP server and the HTTP API, with the title "Edit diagram". (3.7k tokens) - [convert_mermaid](https://docs.plotwork.dev/mcp/tools/convert-mermaid.md): Converts one Mermaid diagram (flowchart or graph, sequenceDiagram, erDiagram, gitGraph, gantt, classDiagram, stateDiagram, timeline, journey, mindmap, treemap-beta or treemap, pie, quadrantChart, C4Context or C4Container or C4Component or C4Dynamic or C4Deployment, sankey-beta or sankey, xychart-beta or xychart, treeView-beta or treeView) to Plotwork source. (3.6k tokens) - [import_source](https://docs.plotwork.dev/mcp/tools/import-source.md): Turns a file into a finished diagram in one call: a database schema, an API spec, infrastructure as code, manifests, a software catalog, a CI workflow, CSV or JSON data, a folder listing, or a git log. (4.2k tokens) - [map_icons](https://docs.plotwork.dev/mcp/tools/map-icons.md): Finds an icon for each of up to 40 service or product names in one call, such as the services of an architecture. It is a workflow of the MCP server and the HTTP API, with the title "Map icons". (1.5k tokens) - [sync_markdown](https://docs.plotwork.dev/mcp/tools/sync-markdown.md): Turns the diagram fences of a Markdown document into pictures, as data. It is a workflow of the MCP server and the HTTP API, with the title "Sync Markdown". (3.4k tokens) - [suggest_diagram](https://docs.plotwork.dev/mcp/tools/suggest-diagram.md): Picks the kind of diagram for a request in plain words, such as "permission matrix for these endpoints and roles" or "where our cloud spend goes", with optional pasted data (a table, a list, numbers by period). (1.6k tokens) - [plan_document_diagrams](https://docs.plotwork.dev/mcp/tools/plan-document-diagrams.md): Reads a whole document (Markdown, HTML, or plain text pasted from Confluence, Notion, or Google Docs), splits it by its headings, and returns the sections a picture would help: the heading and its line, the kind, a one-sentence reason, a confidence, and a starter source drafted from the section's own lists, tables, numbers, and dates. (1.8k tokens) - [find_pattern](https://docs.plotwork.dev/mcp/tools/find-pattern.md): Finds a ready-made, checked architecture diagram for a request such as "three tier network", "serverless api", or "two availability zones". It is a workflow of the MCP server and the HTTP API, with the title "Find pattern". (1.4k tokens) - [get_pattern](https://docs.plotwork.dev/mcp/tools/get-pattern.md): Returns one pattern filled for a flavour: its valid Plotwork source, every slot with its meaning and value, the advice on what to keep, rename, and split, and the structure as groups, overlays, and nodes. (1.6k tokens) - [draw_from_pattern](https://docs.plotwork.dev/mcp/tools/draw-from-pattern.md): Fills a pattern and draws it in one call. It is a workflow of the MCP server and the HTTP API, with the title "Draw from pattern". (4.1k tokens) ## MCP: Single tools - [read_diagram](https://docs.plotwork.dev/mcp/tools/read-diagram.md): Read the source of an existing Plotwork SVG so you can edit the diagram. It is a single tool of the MCP server and the HTTP API, with the title "Read diagram". (1.1k tokens) - [compare_diagrams](https://docs.plotwork.dev/mcp/tools/compare-diagrams.md): Compare two versions of a diagram by meaning, for a pull request review. It is a single tool of the MCP server and the HTTP API, with the title "Compare diagrams". (1.2k tokens) - [get_diagram_syntax](https://docs.plotwork.dev/mcp/tools/get-diagram-syntax.md): Read the diagram language as data. It is a single tool of the MCP server and the HTTP API, with the title "Get diagram syntax". (4.2k tokens) - [validate_diagram](https://docs.plotwork.dev/mcp/tools/validate-diagram.md): Check diagram source without drawing it: every error in one pass, each with line, column, and a fix hint, plus quality warnings. It is a single tool of the MCP server and the HTTP API, with the title "Validate diagram". (2.5k tokens) - [render_diagram](https://docs.plotwork.dev/mcp/tools/render-diagram.md): Render valid source to a self-contained, accessible SVG in the light or dark theme, with its pixel size and quality warnings. It is a single tool of the MCP server and the HTTP API, with the title "Render diagram". (1.5k tokens) - [outline_diagram](https://docs.plotwork.dev/mcp/tools/outline-diagram.md): Describe valid diagram source as plain text: participants, steps, tables, and connections in reading order, to check the diagram says what you meant or to use as alt text. (762 tokens) - [search_icons](https://docs.plotwork.dev/mcp/tools/search-icons.md): Find bundled icon names by keyword, idea, product, or abbreviation ("postgres", "token exchange", "s3", "cosmos db"). It is a single tool of the MCP server and the HTTP API, with the title "Search icons". (761 tokens) ## CLI: Use the CLI - [The Plotwork command line](https://docs.plotwork.dev/cli/overview.md): plotwork checks, draws, and syncs Plotwork diagrams in a repository, on your machine and in CI. (1.4k tokens) - [Command line quick start](https://docs.plotwork.dev/cli/quick-start.md): From an empty page to a diagram that CI keeps in step, in five steps. You need Node 22 or newer and a repository with a Markdown file. (984 tokens) - [Command line configuration](https://docs.plotwork.dev/cli/configuration.md): How the command line finds your repository settings, which commands use which part of them, and how an option on the command line and a setting combine. (1.2k tokens) - [Command line in CI](https://docs.plotwork.dev/cli/ci.md): The pipeline step that fails a build when a diagram picture is stale or a generated diagram has drifted, for GitHub Actions, GitLab CI, Azure Pipelines, Jenkins, and CircleCI. (1.6k tokens) - [Exit codes and output formats](https://docs.plotwork.dev/cli/exit-codes-and-output.md): What each exit code of the command line means, for every command, and what each --format prints. A script or a CI step reads the code; a person reads the text; a code scanner or a test view reads a report. (2.0k tokens) - [Environment variables](https://docs.plotwork.dev/cli/environment.md): Every environment variable the command line reads, and the ones it ignores. A flag on the command line always wins over a variable. (877 tokens) - [Command line troubleshooting](https://docs.plotwork.dev/cli/troubleshooting.md): What a message from the command line means and what to do about it. Most failures are one of the rows below. (1.2k tokens) ## CLI: Command reference - [Command reference](https://docs.plotwork.dev/cli/commands.md): Every command of the Plotwork command line, plotwork, with a page for each. The pages say the same as plotwork --help, which prints the options, defaults, examples, and exit codes of one command in a terminal. (891 tokens) - [plotwork sync](https://docs.plotwork.dev/cli/commands/sync.md): Draw the pictures under every diagram fence of Markdown files; --check fails when one is stale. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (945 tokens) - [plotwork validate](https://docs.plotwork.dev/cli/commands/validate.md): Check every diagram of a Markdown or .diagram file; --strict also fails on warnings. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (675 tokens) - [plotwork check](https://docs.plotwork.dev/cli/commands/check.md): Check every diagram against a team's style rules; fails on a broken rule at level error. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (843 tokens) - [plotwork render](https://docs.plotwork.dev/cli/commands/render.md): Draw the first diagram of a file, or a view link, to an SVG that carries its source. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (796 tokens) - [plotwork read](https://docs.plotwork.dev/cli/commands/read.md): Print the source a Plotwork SVG, a view link, or a hosted link carries, to edit it. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (667 tokens) - [plotwork outline](https://docs.plotwork.dev/cli/commands/outline.md): Print a plain-text outline of every diagram, to check what it says. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (562 tokens) - [plotwork generate](https://docs.plotwork.dev/cli/commands/generate.md): Make the diagrams the settings' sources name from their files; --check fails on drift. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (1.1k tokens) - [plotwork import-source](https://docs.plotwork.dev/cli/commands/import-source.md): Turn SQL, OpenAPI, Terraform, Compose, CSV, a git log, and more into Plotwork source. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (1.2k tokens) - [plotwork import](https://docs.plotwork.dev/cli/commands/import.md): Convert Mermaid to Plotwork: a .mmd file, or every mermaid fence of a Markdown file. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (692 tokens) - [plotwork export](https://docs.plotwork.dev/cli/commands/export.md): Print paste-ready text of the first diagram for Confluence or Notion. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (731 tokens) - [plotwork publish](https://docs.plotwork.dev/cli/commands/publish.md): Save every diagram of a .diagram or Markdown file to Plotwork, where your organisations' Publishing settings decide, and print the link. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (1.1k tokens) - [plotwork icons](https://docs.plotwork.dev/cli/commands/icons.md): Search the bundled icons by name. It is a command of the Plotwork command line, the npm package @buun_group/plotwork. (426 tokens) ## API reference: HTTP API - [API reference](https://docs.plotwork.dev/api/reference.md): Check, render, and describe diagrams written in a small line-oriented language (flow, sequence, schema, git, gantt, class, state, timeline, journey, mindmap, treemap, pie, quadrant, layers, c4, matrix, sankey, xychart, tree, swimlane). (5.1k tokens) - [Schemas](https://docs.plotwork.dev/api/schemas.md): Every request and response type of the HTTP API, with its fields. Each endpoint page links the types it uses. (66.9k tokens) ## API reference: Diagrams - [Draw diagram](https://docs.plotwork.dev/api/post-v1-diagrams-draw.md): Check, describe, and draw a diagram. (3.7k tokens) - [Edit diagram](https://docs.plotwork.dev/api/post-v1-diagrams-edit.md): Change diagram source with small typed operations. (3.4k tokens) - [Convert Mermaid](https://docs.plotwork.dev/api/post-v1-diagrams-convert-mermaid.md): Convert one Mermaid diagram. (4.8k tokens) - [Validate diagram](https://docs.plotwork.dev/api/post-v1-diagrams-validate.md): Check diagram source. (2.6k tokens) - [Render diagram](https://docs.plotwork.dev/api/post-v1-diagrams-render.md): Render diagram source to SVG. (1.7k tokens) - [Outline diagram](https://docs.plotwork.dev/api/post-v1-diagrams-outline.md): Describe diagram source as text. (958 tokens) - [Read diagram](https://docs.plotwork.dev/api/post-v1-diagrams-read.md): Read the source back out of a Plotwork SVG. (2.2k tokens) - [Compare diagrams](https://docs.plotwork.dev/api/post-v1-diagrams-compare.md): Say what changed between two versions of a diagram. (1.5k tokens) - [Suggest diagram](https://docs.plotwork.dev/api/post-v1-diagrams-suggest.md): Choose the kind of diagram for a request. (1.4k tokens) - [Import source](https://docs.plotwork.dev/api/post-v1-import.md): Turn a file of another format into a diagram. (5.3k tokens) ## API reference: Icons - [Map icons](https://docs.plotwork.dev/api/post-v1-icons-map.md): Choose icons for many names at once. (1.4k tokens) - [Search icons](https://docs.plotwork.dev/api/get-v1-icons.md): Find bundled icon names. (740 tokens) ## API reference: Markdown - [Sync Markdown](https://docs.plotwork.dev/api/post-v1-markdown-sync.md): Turn a document's diagram fences into pictures. (3.1k tokens) - [Plan document diagrams](https://docs.plotwork.dev/api/post-v1-markdown-plan.md): Find the sections of a document a picture would help. (1.5k tokens) ## API reference: Patterns - [Find pattern](https://docs.plotwork.dev/api/post-v1-patterns-find.md): Find a ready-made architecture diagram. (1.3k tokens) - [Get pattern](https://docs.plotwork.dev/api/post-v1-patterns-get.md): Read a pattern filled for a flavour. (1.7k tokens) - [Draw from pattern](https://docs.plotwork.dev/api/post-v1-patterns-draw.md): Fill a pattern and draw it. (4.3k tokens) ## API reference: Vocabulary - [Get diagram syntax](https://docs.plotwork.dev/api/get-v1-vocabulary.md): Get the diagram language reference. (4.2k tokens) ## API reference: Auth - [Email a sign-in code](https://docs.plotwork.dev/api/post-auth-code.md): Sends a six-digit code to the address. (597 tokens) - [Sign in with a code](https://docs.plotwork.dev/api/post-auth-verify.md): Checks the code from the email. (695 tokens) - [Sign out](https://docs.plotwork.dev/api/post-auth-logout.md): Ends the session and clears the cookies. (316 tokens) - [Ask whether an address signs in with single sign-on](https://docs.plotwork.dev/api/post-auth-sso-discover.md): { sso: true } only when the address's domain is verified by an organisation whose single sign-on is on and whose plan has it; otherwise { sso: false } and the emailed code works as before. (654 tokens) - [Start signing in through an organisation's identity provider](https://docs.plotwork.dev/api/post-auth-sso-start.md): Answers the provider's address and sets the flow cookie that binds the sign-in to this browser for ten minutes. (803 tokens) - [Finish signing in through an identity provider](https://docs.plotwork.dev/api/get-auth-sso-callback.md): Where the provider sends the browser back. (516 tokens) - [Read an organisation's SAML service provider metadata](https://docs.plotwork.dev/api/get-auth-sso-saml-org-metadata.md): Our entity id, our assertion consumer service on the POST binding, the email name identifier and signed assertions wanted, for one organisation id. (419 tokens) - [Finish signing in through a SAML identity provider](https://docs.plotwork.dev/api/post-auth-sso-saml-org-acs.md): The assertion consumer service. (532 tokens) ## API reference: Keys - [Read the signed-in account](https://docs.plotwork.dev/api/get-user-me.md): Returns the person behind the session cookie. (402 tokens) - [List your API keys](https://docs.plotwork.dev/api/get-user-api-keys.md): Returns the active keys, newest first. (548 tokens) - [Create an API key](https://docs.plotwork.dev/api/post-user-api-keys.md): Makes a key and returns its full value. (788 tokens) - [Reveal an API key](https://docs.plotwork.dev/api/post-user-api-keys-id-reveal.md): Shows the full value of one of your keys again, when a sealed copy was kept. (629 tokens) - [Revoke an API key](https://docs.plotwork.dev/api/delete-user-api-keys-id.md): Stops the key working at once. (415 tokens) - [Read the account's usage](https://docs.plotwork.dev/api/get-user-usage.md): How many metered calls the account made today, the daily limit, when the count resets at 00:00 UTC, and the last 30 days. (686 tokens) ## API reference: Connections - [Approve a request to connect an agent](https://docs.plotwork.dev/api/post-user-mcp-approve.md): Verifies the signed authorization request the MCP server made, makes a hidden API key for the agent, and answers with a signed approval that carries the key sealed. (820 tokens) - [List the agents you have connected](https://docs.plotwork.dev/api/get-user-mcp-connections.md): Returns the agents that signed in with a browser and are still connected, newest first. (546 tokens) - [Disconnect an agent](https://docs.plotwork.dev/api/delete-user-mcp-connections-key-id.md): Ends the connection at once: its key stops working, so the next call from the agent is refused. (461 tokens) ## API reference: Hosting - [Publish a diagram and get a link](https://docs.plotwork.dev/api/post-v1-diagrams-publish.md): Renders the source and stores the SVG at a public link that cannot be guessed. (2.1k tokens) - [List your hosted diagrams](https://docs.plotwork.dev/api/get-user-diagrams.md): The account's hosted diagrams, most recently published first and at most 200, with the account's plan, how many diagrams and bytes it holds in total, and the plan's limits. (1.4k tokens) - [File a hosted diagram in a folder](https://docs.plotwork.dev/api/patch-user-diagrams-id.md): Moves the diagram into a folder (a path such as Payments/Checkout, up to five levels and forty characters a name) or to the top level with null. (708 tokens) - [Delete a hosted diagram](https://docs.plotwork.dev/api/delete-user-diagrams-id.md): Removes the diagram's record, then its file. (562 tokens) - [Lock a hosted diagram](https://docs.plotwork.dev/api/put-user-diagrams-id-lock.md): Locks the diagram so it cannot be deleted, renamed or moved until you unlock it. (461 tokens) - [Unlock a hosted diagram](https://docs.plotwork.dev/api/delete-user-diagrams-id-lock.md): Removes the lock, so the diagram can be deleted, renamed and moved again. (450 tokens) - [Save edited source over a hosted diagram](https://docs.plotwork.dev/api/put-user-diagrams-id-source.md): Draws the source and puts the new picture in place of the diagram's, keeping its id, name, folder and stable links; the picture link changes, so the answer has the new url. (2.4k tokens) - [List a hosted diagram's previous versions](https://docs.plotwork.dev/api/get-user-diagrams-id-versions.md): The pictures the diagram had before it was edited or restored in the portal, newest first, at most ten. (645 tokens) - [Restore a previous version of a hosted diagram](https://docs.plotwork.dev/api/post-user-diagrams-id-versions-version-id-restore.md): Makes the version the diagram's picture, with the checks and the answer of a save. (2.1k tokens) - [Point a stable link at one of your diagrams](https://docs.plotwork.dev/api/post-user-stable-links.md): Points the stable link with this alias at one of your hosted diagrams, making it when you have none of that name. (1.2k tokens) - [Delete a stable link](https://docs.plotwork.dev/api/delete-user-stable-links-id.md): Deletes the stable link, so its address answers 404 from then on (a cache may keep the copy for up to a minute). (510 tokens) - [Describe a diagram link for an embedder (oEmbed)](https://docs.plotwork.dev/api/get-oembed.md): The oEmbed endpoint for Notion, Slack, wikis and other embedders. (911 tokens) ## API reference: Organisations - [List your organisations](https://docs.plotwork.dev/api/get-orgs.md): The organisations the account belongs to, by name, at most 100, each with the caller's role, its plan (its owner's), what it holds, and the limits. (1.6k tokens) - [Create an organisation](https://docs.plotwork.dev/api/post-orgs.md): Makes an organisation owned by the account. (1.9k tokens) - [Read an organisation](https://docs.plotwork.dev/api/get-orgs-org.md): The organisation, the caller's role, its plan (its owner's), what it holds, and the limits. (1.6k tokens) - [Rename an organisation](https://docs.plotwork.dev/api/patch-orgs-org.md): Changes the name. (716 tokens) - [Delete an organisation](https://docs.plotwork.dev/api/delete-orgs-org.md): Removes every diagram file from the private bucket, then the rows. (586 tokens) - [List an organisation's members](https://docs.plotwork.dev/api/get-orgs-org-members.md): Each member's account id, email address, role, and join date. (639 tokens) - [Change a member's role](https://docs.plotwork.dev/api/patch-orgs-org-members-user-id.md): Sets a member's role to admin, member or reader. (806 tokens) - [Remove a member, or leave](https://docs.plotwork.dev/api/delete-orgs-org-members-user-id.md): Removes a member, or leaves when userId is the caller's own. (676 tokens) - [List an organisation's pending invitations](https://docs.plotwork.dev/api/get-orgs-org-invites.md): The invitations that can still be accepted. (699 tokens) - [Invite an address to an organisation](https://docs.plotwork.dev/api/post-orgs-org-invites.md): Emails the address a one-time link and records a pending invitation for seven days. (1.1k tokens) - [Revoke an invitation](https://docs.plotwork.dev/api/delete-orgs-org-invites-id.md): Deletes a pending invitation, so its link stops working. (571 tokens) - [Accept an invitation](https://docs.plotwork.dev/api/post-orgs-invites-accept.md): Joins the organisation the token was made for. (1.8k tokens) - [List an organisation's diagrams](https://docs.plotwork.dev/api/get-orgs-org-diagrams.md): The organisation's diagrams, most recently published first and at most 200, with where the organisation stands against its owner's plan. (1.6k tokens) - [Publish a diagram to an organisation](https://docs.plotwork.dev/api/post-orgs-org-diagrams.md): Renders the source and stores the SVG in the organisation's private library; there is no public link, only a viewUrl for signed-in members. (2.2k tokens) - [Download an organisation diagram's SVG](https://docs.plotwork.dev/api/get-orgs-org-diagrams-id-svg.md): Streams the stored picture to a signed-in member, an organisation's key, or a member's own key, with headers that keep it out of shared caches and out of scripts. (635 tokens) - [File or rename an organisation diagram](https://docs.plotwork.dev/api/patch-orgs-org-diagrams-id.md): Moves the diagram to a folder (or the top level with null) and/or renames it. (1.0k tokens) - [Delete an organisation diagram](https://docs.plotwork.dev/api/delete-orgs-org-diagrams-id.md): Removes the diagram's record, then its file from the private bucket. (777 tokens) - [Lock an organisation diagram](https://docs.plotwork.dev/api/put-orgs-org-diagrams-id-lock.md): Locks the diagram so nobody can delete, rename or move it, the member who published it and the owner included, until the owner unlocks it. (627 tokens) - [Unlock an organisation diagram](https://docs.plotwork.dev/api/delete-orgs-org-diagrams-id-lock.md): Removes the lock, so the diagram can be deleted, renamed and moved again by whoever may. (599 tokens) - [Save edited source over an organisation diagram](https://docs.plotwork.dev/api/put-orgs-org-diagrams-id-source.md): Draws the source with the organisation's brand and icons and stores it in place of the diagram's picture, keeping its id, name and folder; the replaced picture is kept as a previous version. (2.5k tokens) - [List an organisation diagram's previous versions](https://docs.plotwork.dev/api/get-orgs-org-diagrams-id-versions.md): The pictures the diagram had before it was edited or restored in the portal, newest first, at most ten. (733 tokens) - [Restore a previous version of an organisation diagram](https://docs.plotwork.dev/api/post-orgs-org-diagrams-id-versions-version-id-restore.md): Makes the version the diagram's picture, with the checks and the answer of a save. (2.2k tokens) - [Keep an organisation's diagrams editable](https://docs.plotwork.dev/api/put-orgs-org-editable.md): Turns the owner's setting on or off. (872 tokens) - [Choose where an organisation's members publish](https://docs.plotwork.dev/api/put-orgs-org-publishing.md): personal, organisation-default (a member's publish that names no organisation goes to the private library) or organisation-required (nothing a member publishes reaches a public link). (1.2k tokens) - [List members' public diagrams for review](https://docs.plotwork.dev/api/get-orgs-org-publishing-public-diagrams.md): While the organisation requires its library: the public diagrams members published since they joined, newest first, at most 200. (937 tokens) - [Move a member's public diagram into the library](https://docs.plotwork.dev/api/post-orgs-org-publishing-public-diagrams-id-move.md): Copies the picture into the private library under a new id, then removes the public diagram and its stable links. (1.4k tokens) - [Unpublish a member's public diagram](https://docs.plotwork.dev/api/delete-orgs-org-publishing-public-diagrams-id.md): Removes the public diagram, its previous versions and its stable links. (661 tokens) - [Read where your publishes go](https://docs.plotwork.dev/api/get-user-publishing.md): The organisations that claim the account's publishes, its default organisation, and where a publish that names no organisation goes now. (701 tokens) - [Choose your default organisation for publishing](https://docs.plotwork.dev/api/put-user-publishing.md): The organisation that takes a publish naming none when several claim it, or none with null. (990 tokens) - [List an organisation's folder rules](https://docs.plotwork.dev/api/get-orgs-org-folder-rules.md): Each restricted folder with the roles and the people let in. (818 tokens) - [Restrict a folder](https://docs.plotwork.dev/api/put-orgs-org-folder-rules.md): Makes or replaces the rule for a folder and everything inside it. (859 tokens) - [Remove a folder's rule](https://docs.plotwork.dev/api/delete-orgs-org-folder-rules.md): Removes the rule for the folder in the folder query, so the folder is open again. (689 tokens) - [List an organisation's API keys](https://docs.plotwork.dev/api/get-orgs-org-keys.md): The organisation's active keys, newest first. (802 tokens) - [Create an organisation API key](https://docs.plotwork.dev/api/post-orgs-org-keys.md): Makes a key that belongs to the organisation and returns its full value. (1.1k tokens) - [Reveal an organisation API key](https://docs.plotwork.dev/api/post-orgs-org-keys-id-reveal.md): Shows the full value of one of the organisation's keys again, to the owner or an admin. (743 tokens) - [Revoke an organisation API key](https://docs.plotwork.dev/api/delete-orgs-org-keys-id.md): Stops the key working at once. (547 tokens) - [Read an organisation's brand theme](https://docs.plotwork.dev/api/get-orgs-org-brand.md): The saved brand colors, which of them were chosen, whether the hosted service paints with them (a brand is saved and the owner's plan includes brand themes), whether the caller may change them, and the plan. (791 tokens) - [Save an organisation's brand theme](https://docs.plotwork.dev/api/put-orgs-org-brand.md): Saves one to three colors. (1.2k tokens) - [Remove an organisation's brand theme](https://docs.plotwork.dev/api/delete-orgs-org-brand.md): Removes the saved colors, so diagrams are drawn in the built-in theme again. (547 tokens) - [Preview brand colors](https://docs.plotwork.dev/api/post-orgs-org-brand-preview.md): Draws two fixed sample diagrams in the colors given, in light and dark, with the check. (1.2k tokens) - [Read the brand of your own calls](https://docs.plotwork.dev/api/get-user-brand.md): The organisation whose brand the account's own calls use, or null, and the organisations the account belongs to that have a saved brand. (640 tokens) - [Choose the brand of your own calls](https://docs.plotwork.dev/api/put-user-brand.md): Chooses the organisation whose brand the account's own calls use, or none with null. (611 tokens) - [Read an organisation's style rules](https://docs.plotwork.dev/api/get-orgs-org-style-rules.md): The saved style rules, as written and parsed, whether CI applies them (rules are saved and the owner's plan includes them), whether the caller may change them, and the plan. (828 tokens) - [Save an organisation's style rules](https://docs.plotwork.dev/api/put-orgs-org-style-rules.md): Saves the rules file as JSON text, for CI to read with an organisation key. (1.1k tokens) - [Remove an organisation's style rules](https://docs.plotwork.dev/api/delete-orgs-org-style-rules.md): Removes the saved rules. (524 tokens) - [List an organisation's custom icons](https://docs.plotwork.dev/api/get-orgs-org-icons.md): The organisation's own icons, each with its org: reference, aliases, and checked picture, with whether the hosted service draws them (the owner's plan includes custom icons), whether the caller may change them, the plan, and its limit. (883 tokens) - [Upload or replace a custom icon](https://docs.plotwork.dev/api/put-orgs-org-icons-name.md): Saves one SVG or PNG icon (at most 32 KB) under a name diagrams use as icon=org: on the hosted service, with up to ten aliases. (1.2k tokens) - [Delete a custom icon](https://docs.plotwork.dev/api/delete-orgs-org-icons-name.md): Deletes one icon. (562 tokens) - [Preview a custom icon in a diagram](https://docs.plotwork.dev/api/get-orgs-org-icons-name-preview.md): Draws one icon on a box of a small fixed diagram, in light and dark, in the organisation's brand while it is active. (714 tokens) - [Read an organisation's avatar](https://docs.plotwork.dev/api/get-orgs-org-avatar.md): The uploaded avatar as the check stored it, with nosniff, a policy that lets it draw and nothing else, and a private cache keyed by the version in the address. (593 tokens) - [Upload or replace an organisation's avatar](https://docs.plotwork.dev/api/put-orgs-org-avatar.md): Saves one SVG, PNG, APNG, GIF or WebP avatar, still or animated (at most 256 KB, 512 pixels, 200 frames). (1.1k tokens) - [Remove an organisation's avatar](https://docs.plotwork.dev/api/delete-orgs-org-avatar.md): Deletes the uploaded avatar, so the mark made from the organisation's id shows again. (550 tokens) - [Report a drift run from CI](https://docs.plotwork.dev/api/post-orgs-org-drift-runs.md): What one run of the GitHub Action's generate command found in one repository: per source its status, change counts, errors and owners. (1.6k tokens) - [Read an organisation's drift dashboard](https://docs.plotwork.dev/api/get-orgs-org-drift.md): Whether the dashboard is on, the plan and the days runs are kept, every repository with its counts, the latest status of every source with its owners (stale first), and the newest runs. (1.4k tokens) - [Read an organisation's audit log](https://docs.plotwork.dev/api/get-orgs-org-audit.md): One page of the audit log, newest first: who did what to what, and when. (1.8k tokens) - [Export an organisation's audit log](https://docs.plotwork.dev/api/get-orgs-org-audit-export.md): The audit log oldest first, as JSON Lines or CSV, at most 1000 events an export. (888 tokens) - [Read an organisation's single sign-on settings](https://docs.plotwork.dev/api/get-orgs-org-sso.md): The connection to the identity provider (never the client secret), the email domains with the DNS record each needs, the redirect URI to register, and whether the plan has single sign-on. (1.4k tokens) - [Set up an OpenID Connect identity provider](https://docs.plotwork.dev/api/put-orgs-org-sso-connection.md): Stores the issuer, the client id and the client secret after checking the issuer's discovery document. (1.4k tokens) - [Turn single sign-on on or off, and set Require SSO and who joins on first sign-in](https://docs.plotwork.dev/api/patch-orgs-org-sso-connection.md): Each field left out keeps its value. (1.3k tokens) - [Remove the identity provider](https://docs.plotwork.dev/api/delete-orgs-org-sso-connection.md): Removes the connection and its secret; sign-in through the provider stops. (595 tokens) - [Set up a SAML identity provider](https://docs.plotwork.dev/api/put-orgs-org-sso-saml.md): Reads the provider's metadata from its HTTPS address or pasted XML and stores the entity id, the sign-in service and the signing certificates. (1.4k tokens) - [Add an email domain](https://docs.plotwork.dev/api/post-orgs-org-sso-domains.md): Adds a domain and answers the TXT record to publish at _plotwork-verify.. (1.0k tokens) - [Check a domain's DNS record](https://docs.plotwork.dev/api/post-orgs-org-sso-domains-domain-verify.md): Looks up the TXT record through DNS over HTTPS and marks the domain verified when it matches. (908 tokens) - [Remove an email domain](https://docs.plotwork.dev/api/delete-orgs-org-sso-domains-domain.md): Removes the domain. (582 tokens) - [Read an organisation's SCIM settings](https://docs.plotwork.dev/api/get-orgs-org-scim.md): The SCIM base URL, the live token without its value, how many people the provider manages, its groups and their roles, and whether the plan includes SCIM. (895 tokens) - [Make or rotate the SCIM token](https://docs.plotwork.dev/api/post-orgs-org-scim-token.md): Makes a bearer token for the identity provider, shown once and stored only as a hash. (763 tokens) - [Revoke the SCIM token](https://docs.plotwork.dev/api/delete-orgs-org-scim-token.md): The provider's next SCIM call is refused. (546 tokens) - [Choose the role a SCIM group gives](https://docs.plotwork.dev/api/patch-orgs-org-scim-groups-group.md): admin, member, reader, or null. (837 tokens) - [Read what priority support is for an organisation](https://docs.plotwork.dev/api/get-orgs-org-support.md): The named contact, the first response target, the support hours and whether the plan has an uptime SLA, for every member; the contract dates for the owner and admins, never its price. (933 tokens) - [Ask the organisation's named contact for help](https://docs.plotwork.dev/api/post-orgs-org-support-requests.md): A subject, a message and a severity, stored for 365 days and emailed to the named contact with the sender as the reply-to. (1.1k tokens) ## API reference: Billing - [Read the account's plan](https://docs.plotwork.dev/api/get-user-billing.md): The plan the account gets right now, the status of its subscription, when the period paid for ends, whether it is set to end then, and whether the account has billing details at Stripe. (661 tokens) - [Start a checkout for a paid plan](https://docs.plotwork.dev/api/post-user-billing-checkout.md): Makes a Stripe Checkout Session for the plan and returns the address of Stripe's hosted page. (769 tokens) - [Read a finished checkout back](https://docs.plotwork.dev/api/post-user-billing-verify-checkout.md): Asks Stripe for the checkout session and its subscription and stores the same state the webhook stores. (960 tokens) - [Cancel the plan at the end of the period](https://docs.plotwork.dev/api/post-user-billing-cancel.md): Sets the subscription to end with the period already paid for. (982 tokens) - [Take back a cancellation](https://docs.plotwork.dev/api/post-user-billing-resume.md): Undoes a cancellation made earlier in the period, so the subscription renews. (800 tokens) - [Open the Stripe billing portal](https://docs.plotwork.dev/api/post-user-billing-portal.md): Makes a Stripe Billing Portal session for the account and returns its address. (638 tokens) - [List your invoices and receipts](https://docs.plotwork.dev/api/get-user-billing-documents.md): The invoices Stripe issued for this account's Plotwork subscription, newest first. (836 tokens) - [Read one invoice or receipt](https://docs.plotwork.dev/api/get-user-billing-documents-id.md): One document with its lines, totals, who it is billed to, the issuer, and the card as a brand and last four digits. (1.3k tokens) - [Download an invoice or receipt as a PDF](https://docs.plotwork.dev/api/get-user-billing-documents-id-pdf.md): The PDF Stripe made for the invoice, as a file to save. (572 tokens) - [Receive a Stripe event. Called by Stripe, not by clients](https://docs.plotwork.dev/api/post-billing-webhook.md): Called by Stripe, not by clients. (817 tokens) ## API reference: Enterprise - [Send an Enterprise enquiry](https://docs.plotwork.dev/api/post-enterprise-enquiries.md): For the Enterprise page of the Plotwork site and the Talk to sales form of the portal. (1.4k tokens) ## API reference: Telemetry - [Receive the opt-in daily totals of the local npm package](https://docs.plotwork.dev/api/post-telemetry-usage.md): For the local npm package (@buun_group/plotwork-mcp) only, and only when the person who runs it has set PLOTWORK_USAGE=share; it is off by default, and setting DO_NOT_TRACK=1 stops the package from ever sending. (1.6k tokens) ## API reference: Health - [Check the service is up](https://docs.plotwork.dev/api/get-health.md): Always answers 200 with the package version and the diagram kinds this build renders. (376 tokens) ## Language: Language reference - [Language reference](https://docs.plotwork.dev/reference/language.md): Every word the diagram language accepts: kinds, node types, groups, arrows, tones, icons, limits, and diagnostic codes. Each topic has its own page, so a reader or an agent loads only what the task needs. (1.4k tokens) - [Diagram kinds and settings](https://docs.plotwork.dev/reference/language/kinds.md): The twenty kinds of diagram with an example of each, and the settings a diagram accepts: tones, directions, themes, sequence frames, and schema column flags. (20.1k tokens) - [Flow node types](https://docs.plotwork.dev/reference/language/flow-nodes.md): Every type a flow node can take, with its shape, default tone and icon, the technology marks a node can carry, and the mark of a planned change. (1.1k tokens) - [Groups and overlays](https://docs.plotwork.dev/reference/language/groups.md): How a group frames nodes and nested groups, the options it takes, and how an overlay draws a frame around members that layout placed apart. (1.9k tokens) - [Group types](https://docs.plotwork.dev/reference/language/group-types.md): Every group type with its frame style and tone, the icon each draws for each provider, and a complete cloud architecture diagram. (3.2k tokens) - [Arrows and edge labels](https://docs.plotwork.dev/reference/language/edges.md): The arrow tokens, the labels and icons an edge can carry, the level edge that keeps mirrored columns side by side, and the options that animate a line, number the steps, or color a line by what it carries. (4.0k tokens) - [Icon sets and status icons](https://docs.plotwork.dev/reference/language/icon-sets.md): The icon sets a diagram can draw from, how a provider product is written, and the status icons that keep their own color. (1.8k tokens) - [Limits and quality checks](https://docs.plotwork.dev/reference/language/limits.md): How large a diagram may be, the quality warnings that fire past the density limits, and the two suggestions that name an icon or a group type to add. (2.5k tokens) - [Diagnostic codes](https://docs.plotwork.dev/reference/language/diagnostics.md): Every error and warning code with its severity and name, and how to read one. (2.9k tokens) ## Language: Icons - [Icon reference](https://docs.plotwork.dev/reference/icons.md): Every bundled icon, grouped by what it is for, and how to find the right one. (9.3k tokens) ## Machine-readable files - [llms.txt](https://docs.plotwork.dev/llms.txt): An index of every page: its title, address, a line on what it holds, and its size in tokens. You do not know which page you need. Read this first. - [llms-docs.txt](https://docs.plotwork.dev/llms-docs.txt): The text of every page in the Documentation tab except the optional ones, in one file. You need all of Documentation in one fetch. A tab bundle is the recommended way to load a whole subject. (143k tokens) - [llms-agents.txt](https://docs.plotwork.dev/llms-agents.txt): The text of every page in the AI agents tab except the optional ones, in one file. You need all of AI agents in one fetch. A tab bundle is the recommended way to load a whole subject. (14.7k tokens) - [llms-mcp.txt](https://docs.plotwork.dev/llms-mcp.txt): The text of every page in the MCP tab except the optional ones, in one file. You need all of MCP in one fetch. A tab bundle is the recommended way to load a whole subject. (66.0k tokens) - [llms-cli.txt](https://docs.plotwork.dev/llms-cli.txt): The text of every page in the CLI tab except the optional ones, in one file. You need all of CLI in one fetch. A tab bundle is the recommended way to load a whole subject. (20.0k tokens) - [llms-api.txt](https://docs.plotwork.dev/llms-api.txt): The text of every page in the API reference tab except the optional ones, in one file. You need all of API reference in one fetch. A tab bundle is the recommended way to load a whole subject. (223k tokens) - [llms-reference.txt](https://docs.plotwork.dev/llms-reference.txt): The text of every page in the Language tab except the optional ones, in one file. You need all of Language in one fetch. A tab bundle is the recommended way to load a whole subject. (48.3k tokens) - [llms-full.txt](https://docs.plotwork.dev/llms-full.txt): The text of every page except the optional ones, in one file. It is the largest file here. You are loading the whole documentation into a search index. For a task, read a tab bundle instead. (515k tokens) - [tools.json](https://docs.plotwork.dev/reference/tools.json): The name, description, behavior hints, and JSON Schema of every tool. You build a client or a tool call and need the exact schema. - [openapi.json](https://docs.plotwork.dev/reference/openapi.json): The OpenAPI 3.1 document of the HTTP API. You call the HTTP API and want a generated client or the exact request and response shapes. - [sitemap.xml](https://docs.plotwork.dev/sitemap.xml): The address of every page. You crawl the site. - [robots.txt](https://docs.plotwork.dev/robots.txt): What crawlers may fetch, and where the sitemap is. You run a crawler. ## Optional - [Architecture patterns](https://docs.plotwork.dev/architecture-patterns.md): A pattern is a ready-made, checked diagram for a common architecture: a three-tier network, a two-zone network, a serverless API, a delivery pipeline, a sign-in flow, a starter database schema. (24.4k tokens) - [Git graphs](https://docs.plotwork.dev/git-graphs.md): A git graph draws a repository history as lanes: one lane for each branch, with the commits along the lanes and the merges, tags, and cherry-picks marked on them. (4.6k tokens) - [Gantt charts](https://docs.plotwork.dev/gantt-charts.md): A Gantt chart draws a plan on a time axis: tasks as bars, milestones as diamonds, and lines for what waits for what. Use it for a project plan, a roadmap, a release schedule, or any work where order and dates matter. (5.4k tokens) - [Class diagrams](https://docs.plotwork.dev/class-diagrams.md): Draw the classes of an object model, the members each one holds, and the relations between them, with the marks UML gives each relation: a hollow triangle for inheritance, a diamond for composition, an open arrow for an association. (4.4k tokens) - [State diagrams](https://docs.plotwork.dev/state-diagrams.md): A state diagram shows the states of something and the events that move it from one to another: an order, a ticket, an agent run, a connection, a download, a release. Use it for a lifecycle or a state machine. (9.2k tokens) - [Timelines](https://docs.plotwork.dev/timelines.md): A timeline draws dated events on a rail, in the order you write them, with the periods grouped into eras. Use it for a company or product history, a release train, a roadmap, or a changelog read in order. (4.1k tokens) - [User journeys](https://docs.plotwork.dev/user-journeys.md): A journey diagram shows the steps a person takes, how satisfied they are at each one, and who is involved. (3.7k tokens) - [Mind maps](https://docs.plotwork.dev/mind-maps.md): A mind map draws one central idea and the branches that grow from it, with the idea in the middle and its branches on both sides, or as a tidy tree. Use it to plan, to sort a pile of thoughts, or to show what a topic is made of. (4.2k tokens) - [Treemaps](https://docs.plotwork.dev/treemaps.md): A treemap draws nested areas sized by value: each tile is an item, its area is its value, and the frames round tiles are the groups they belong to. (5.1k tokens) - [Pie charts](https://docs.plotwork.dev/pie-charts.md): A pie chart shows how one total splits into parts: traffic by source, spend by team, bugs by cause. Plotwork draws it as a donut, with the total in the hole, a label on a thin line for each big slice, and a legend for the small ones. (3.6k tokens) - [Quadrant charts](https://docs.plotwork.dev/quadrant-charts.md): A quadrant chart places items on two axes and divides the plot into four zones, so the reader sees at a glance which items to do first, which to watch, and which to drop. (4.1k tokens) - [Layered architecture](https://docs.plotwork.dev/layered-architecture.md): A layered diagram stacks the tiers of a system, one wide layer for each, with the blocks that live in each layer and the few links that show how the layers call each other. (5.9k tokens) - [C4 diagrams](https://docs.plotwork.dev/c4-diagrams.md): A C4 diagram shows the architecture of a software system at one level of zoom: who uses it, what it is made of, what one part is made of, where it runs, or how one scenario plays out. (7.9k tokens) - [Matrices](https://docs.plotwork.dev/matrices.md): A matrix puts rows against columns and gives every cell a meaning. (6.2k tokens) - [Sankey diagrams](https://docs.plotwork.dev/sankey-diagrams.md): A sankey diagram draws flows between stages as ribbons as thick as the amount that moves. (5.1k tokens) - [XY charts](https://docs.plotwork.dev/xy-charts.md): An XY chart plots numbers against places: latency by week, CPU by hour, cost by month, p95 by endpoint. (5.6k tokens) - [Tree diagrams](https://docs.plotwork.dev/tree-diagrams.md): A tree diagram draws a hierarchy: the layout of a repository, the files a pull request changes, a company's teams, who owns which service, or a taxonomy. It replaces the ASCII tree that gets pasted into a README. (5.6k tokens) - [Swimlane diagrams](https://docs.plotwork.dev/swimlane-diagrams.md): A swimlane diagram shows a process and who does each part of it: a lane for each actor or system, steps in the lane that performs them, decisions, and the hand-offs between lanes. (6.5k tokens) - [AWS icons](https://docs.plotwork.dev/cloud-icons/aws.md): Every Amazon Web Services icon Plotwork draws, grouped the way AWS groups its architecture icons, each drawn above its name, with the exact icon= to write and the other names that find it. (17.4k tokens) - [Azure icons](https://docs.plotwork.dev/cloud-icons/azure.md): Every Microsoft Azure icon Plotwork draws, grouped the way Microsoft groups its Azure icons, each drawn above its name, with the exact icon= to write and the other names that find it. (11.6k tokens) - [Google Cloud icons](https://docs.plotwork.dev/cloud-icons/google-cloud.md): Every Google Cloud icon Plotwork draws, grouped the way Google groups its product icons, each drawn above its name, with the exact icon= to write and the other names that find it. (2.0k tokens) - [Other provider icons](https://docs.plotwork.dev/cloud-icons/other-providers.md): The icons of Alibaba Cloud, Oracle Cloud Infrastructure, IBM Cloud, Cloudflare, DigitalOcean, and Vercel, each drawn above its name, with the exact icon= to write and the other names that find it. (6.5k tokens) - [Generic and technology icons](https://docs.plotwork.dev/cloud-icons/generic.md): The icons that are not a cloud provider's: general icons from Lucide, technology and brand logos from Simple Icons, the colored status icons, and the glyph each kind of cloud service draws. (5.3k tokens) - [Trademarks and icons](https://docs.plotwork.dev/trademarks-and-icons.md): Plotwork draws the official AWS, Microsoft Azure, and Google Cloud architecture icons exactly as each company publishes them, to depict those companies' services in architecture diagrams. (3.2k tokens) - [Privacy policy](https://docs.plotwork.dev/privacy-policy.md): This policy says what personal data Plotwork collects, why, how long it is kept, who handles it for us, and how to use your rights. (19.3k tokens) - [Cookie policy](https://docs.plotwork.dev/cookie-policy.md): This policy lists every cookie and stored item that Plotwork sets, what each one is for, and how long it lasts. It also says what happens when you accept, reject, or ignore the cookie banner, and how to change your mind. (3.9k tokens)