cysUML
Provides tools for drawing and validating UML diagrams, including class, package, component, and sequence diagrams, with AI-assisted layout and PNG output.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@cysUML draw a class diagram of an order system and validate its layout"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
cysUML
An MCP server for document-ready UML diagrams: the AI lays them out, cysUML draws and checks them.
Auto-layout tools keep boxes apart, but they decide where everything goes: it is hard to get the arrangement you want, one more class can reshuffle the whole picture, and labels can still crowd the lines. cysUML takes the other way round: your AI assistant decides where every box goes, cysUML draws exactly that and checks the drawing. An assistant placing boxes itself can get it wrong, so if boxes overlap, a line runs through a box or a label, or labels overlap, the check fails and says what to move. The assistant fixes the layout and draws again until the check passes.
Several kinds of UML diagram; the list is under Use. Sequence diagrams are laid out by cysUML from the order of participants and messages, and checked the same way.
PNG output. The fonts are bundled, so every machine draws the same picture, Korean text included.
For example, here the assistant first put Product right under OrderLine, on the line from Customer to Payment. The
line then passes under the Product box, which hides it, and the picture says something the model doesn't: Product is
not related to Customer or Payment, yet it looks as if pays joined Customer to Product, and as if Product had its own
line to Payment. The check fails on exactly this and tells the assistant to move that box or change the line's bend
points:

The assistant moved Product to the right of OrderLine, pulled Payment and CardPayment left into the room it left, drew again, and the check passed:

Install
You need uv. This one line downloads cysUML from PyPI and starts the server:
uvx cysumlIt talks MCP over stdin/stdout, so on its own it just waits for a client. Register it with your MCP client instead.
Claude Code
claude mcp add cysuml -- uvx cysumlOther clients (Claude Desktop, Cursor, …) take the same command in their JSON config:
{
"mcpServers": {
"cysuml": {
"command": "uvx",
"args": ["cysuml"]
}
}
}Versions. uvx cysuml runs the newest release: each time the client starts the server, uv asks PyPI and reuses
the answer for up to ten minutes. If you installed it with uv tool install cysuml, uvx runs that copy instead;
update it with uv tool upgrade cysuml. To stay on one version, put it after the name: uvx cysuml@0.2.1 (in JSON,
"args": ["cysuml@0.2.1"]). The releases are listed in the release history.
Related MCP server: drawio-mcp
Use
Ask your assistant for a diagram, for example "draw a class diagram of the order domain with cysUML" or "draw the checkout flow as a sequence diagram with cysUML". The server tells the assistant how to lay it out, so you don't have to.
Class diagrams
The tool is draw_class_diagram. The assistant sends boxes with their top-left corners and relations with
optional bend points:
{
"file_name": "order",
"classes": [
{"name": "Order", "left": 0, "top": 0, "attributes": ["-id: long"]},
{"name": "Customer", "left": 200, "top": 0}
],
"relations": [
{"kind": "association", "from": "Order", "to": "Customer", "name": "places", "to_multiplicity": "1"}
]
}
It gets back the check result, the size and place of every box as drawn, the saved file paths, and the picture.
The check fails when boxes overlap, a line runs through a box, a label or another line's arrowhead, or labels
overlap. A relation's name is drawn on top of that relation's line, which breaks around the name, so the stretch of
line it sits on doesn't count as running through it (the rest of that line, its end shapes and other lines still do).
A name with no room on its line (including a line too short to stay visible on both sides of the name), or on a line
that loops back to the same box, goes beside the line, and if putting the names on their lines makes the whole picture
fail more, every name goes beside its line.
Crossing lines and the picture size are reported but don't fail. Inheritance lines from several children to
one parent may join into one trunk that shares a single triangle (realization lines too, but not mixed with
inheritance); the relations argument description tells the assistant how to give the bend points for it. When both
kinds come to one parent, the result lists a point for each kind either side of the point the parent's lines aim at
(usually its middle); a line whose last bend point sits right below its kind's point goes straight up to it, so the
two triangles sit side by side. A parent too narrow for two triangles (a class drawn narrower than 48px, or in the
package, component and deployment tools an icon-style artifact) gets no points.
Relations must follow UML notation, and the tool rejects the input otherwise: a generalization joins two boxes of the same kind (a class and an abstract class count as one kind), never runs in a cycle, and neither a generalization nor a realization points back to its own box. A realization made by an interface, or one that ends on something other than an interface, is drawn and reported as a notice. The package, component and deployment tools follow the same rules. There a package or a provided interface ball is never an end of a generalization, a realization made by either of them gets a notice, and a realization from a class to a component (the class realizes the component) does not. Icon notations of components and artifacts count as the same kind as the plain ones.
Package diagrams
The tool is draw_package_diagram. It draws packages and the dependencies between them, with classes and packages
inside packages, and takes components, artifacts and nodes in the same picture. Every element has a kind. An element
names the one it sits in with in, and the outer element grows right and down to cover it:
{
"file_name": "packages",
"elements": [
{"kind": "package", "name": "web", "left": 0, "top": 0},
{"kind": "class", "name": "OrderController", "in": "web", "left": 20, "top": 44},
{"kind": "package", "name": "domain", "left": 0, "top": 180},
{"kind": "class", "name": "Order", "in": "domain", "left": 20, "top": 224},
{"kind": "class", "name": "Customer", "in": "domain", "left": 200, "top": 224}
],
"relations": [
{"kind": "dependency", "from": "web", "to": "domain", "stereotype": "use"},
{"kind": "association", "from": "Order", "to": "Customer", "name": "places", "to_multiplicity": "1"}
]
}
It gets back the same things as the class diagram tool, with the place of every element (and, for a package, the point its lines aim at, since that is not the middle of the package). Besides the class diagram checks, the check fails when an element inside another sits too close to its edge or name tab, or a line runs along the edge of a package it starts or ends in, or through a package's name tab.
Components and artifacts can also be drawn in icon notation. component_icon is the UML 1 component: a box with two
small rectangles across its left edge, which lines may not cross. artifact_icon is a folded-page icon with the name
(often a file name) outside it, on the side name_side gives.
Component diagrams
The tool is draw_component_diagram. It draws components with the interfaces they provide, the artifacts that
implement them, and the classes that realize them. It takes every element of the package diagram tool (icon notations included), plus
lollipop: a provided interface drawn as a small circle with its name outside (name_side puts the name below,
above, left or right of the circle). The providing component joins the circle with an association, drawn without
an arrowhead in this tool unless navigable is given, and each user points at the circle with a dependency:
{
"file_name": "components",
"elements": [
{"kind": "package", "name": "web", "left": 0, "top": 0},
{"kind": "component", "name": "OrderController", "in": "web", "left": 20, "top": 44},
{"kind": "component", "name": "AdminController", "in": "web", "left": 220, "top": 44},
{"kind": "package", "name": "service", "left": 0, "top": 220},
{"kind": "component", "name": "OrderService", "in": "service", "left": 110, "top": 324},
{"kind": "lollipop", "name": "OrderApi", "in": "service", "left": 70, "top": 264, "name_side": "left"},
{"kind": "artifact", "name": "order-service.jar", "left": 400, "top": 324}
],
"relations": [
{"kind": "association", "from": "OrderService", "to": "OrderApi"},
{"kind": "dependency", "from": "OrderController", "to": "OrderApi"},
{"kind": "dependency", "from": "AdminController", "to": "OrderApi"},
{"kind": "dependency", "from": "order-service.jar", "to": "OrderService", "stereotype": "manifest"}
]
}
It gets back the same things as the package diagram tool, and for each circle the place of the circle alone next to the place of the circle with its name. The checks are the same: a line through a circle or its name fails.
A user of an interface can also be drawn as a socket. A requires relation from the user to the circle is a solid
line that stops short of the circle and ends in a half circle wrapped around it (ball and socket). Its to must be a
lollipop and its from must not be one. A circle takes one socket, since two half circles overlap, so any other
user points at the circle with a dependency. A line that touches a half circle fails. With the icon notations,
the same tool draws a textbook-style picture of UML 1 components and folded-page artifacts:
{
"file_name": "billing",
"elements": [
{"kind": "artifact_icon", "name": "Billing.exe", "left": 38, "top": 0, "name_side": "right"},
{"kind": "component_icon", "name": "Billing", "left": 0, "top": 110},
{"kind": "lollipop", "name": "IBilling", "left": 190, "top": 124},
{"kind": "component_icon", "name": "Register", "stereotype": "component", "left": 320, "top": 103},
{"kind": "component_icon", "name": "Course", "left": 0, "top": 260},
{"kind": "artifact_icon", "name": "Course.dll", "left": 24, "top": 380}
],
"relations": [
{"kind": "dependency", "from": "Billing.exe", "to": "Billing", "stereotype": "manifest"},
{"kind": "association", "from": "Billing", "to": "IBilling"},
{"kind": "requires", "from": "Register", "to": "IBilling"},
{"kind": "dependency", "from": "Register", "to": "Course", "via": [[385, 284]]},
{"kind": "dependency", "from": "Course.dll", "to": "Course", "stereotype": "manifest"}
]
}
Deployment diagrams
The tool is draw_deployment_diagram. It shows which computers (nodes) the software runs on: components and
artifacts sit inside nodes with in, and a node can sit inside another node. It takes the same elements as the package
diagram tool, icon notations included. A communication path between nodes is an association with the protocol as its name. This tool draws
every association without an arrowhead (between classes too) unless navigable says otherwise. A «deploy» arrow from
an element outside a node is a dependency with "stereotype": "deploy":
{
"file_name": "deployment",
"elements": [
{"kind": "node", "name": "PC", "stereotype": "device", "left": 0, "top": 0, "height": 220},
{"kind": "component", "name": "Browser", "in": "PC", "left": 20, "top": 66},
{"kind": "node", "name": "App Server", "stereotype": "device", "left": 240, "top": 0, "height": 220},
{"kind": "node", "name": "Tomcat", "stereotype": "executionEnvironment", "in": "App Server", "left": 260, "top": 66},
{"kind": "component", "name": "OrderService", "in": "Tomcat", "left": 280, "top": 132},
{"kind": "node", "name": "DB Server", "stereotype": "device", "left": 620, "top": 0, "height": 220},
{"kind": "artifact", "name": "orders.db", "in": "DB Server", "left": 640, "top": 66},
{"kind": "artifact", "name": "order.war", "left": 310, "top": 280}
],
"relations": [
{"kind": "association", "from": "PC", "to": "App Server", "name": "HTTPS"},
{"kind": "association", "from": "App Server", "to": "DB Server", "name": "JDBC"},
{"kind": "dependency", "from": "order.war", "to": "Tomcat", "stereotype": "deploy"}
]
}
It gets back the same things as the package diagram tool, and the check fails in the same cases, such as a communication path running through a node it does not connect or through an element inside one.
Use case diagrams
The tool is draw_use_case_diagram. It draws actors, use cases and the system boundary, joined by associations,
«include» and «extend» dependencies, and generalizations. Use cases sit inside the system boundary with in. Actors
stand outside it and write their name beside the figure, on the side name_side gives:
{
"file_name": "use-cases",
"elements": [
{"kind": "system", "id": "shop", "name": "Online shop", "left": 160, "top": 0},
{"kind": "use_case", "name": "Browse items", "in": "shop", "left": 200, "top": 50},
{"kind": "use_case", "name": "Place order", "in": "shop", "left": 200, "top": 150},
{"kind": "use_case", "name": "Pay", "in": "shop", "left": 420, "top": 150},
{"kind": "actor", "name": "Customer", "left": 0, "top": 130, "name_side": "left"},
{"kind": "actor", "name": "Bank", "left": 660, "top": 157, "name_side": "right"}
],
"relations": [
{"kind": "association", "from": "Customer", "to": "Browse items"},
{"kind": "association", "from": "Customer", "to": "Place order"},
{"kind": "dependency", "from": "Place order", "to": "Pay", "stereotype": "include"},
{"kind": "association", "from": "Pay", "to": "Bank"}
]
}
It gets back the same things as the package diagram tool. An actor's place covers the figure and its name, and the figure's own place comes after it. The check is the same as for package diagrams, and it also fails when a line runs through an actor's name or the name at the top of the system boundary. Generalization lines to one parent may share one trunk, as inheritance lines do in class diagrams.
Elements and relations must follow UML notation, and the tool rejects the input otherwise. An actor stays outside the system boundary, and no relation of any kind ends on the system boundary. An association joins an actor and a use case, or two use cases whose boundaries differ (different boundaries, or one inside a boundary and one outside); it never joins two actors, two use cases of the same boundary, or two use cases both outside any boundary. A generalization joins two actors or two use cases and never runs in a cycle or back to itself. «include» and «extend» go only on dependencies between use cases; a use case never includes or extends itself, and neither includes nor extends run in a cycle.
State diagrams
The tool is draw_state_diagram. It draws start and end points, states and choice diamonds joined by transitions. A
state lists its entry /, do / and exit / lines in actions, written as given, and can hold other states with
in. Start and end points and choices have no name, so they get an id for transitions to point to. The transition
name is written as given too, brackets and slash included:
{
"file_name": "order-states",
"elements": [
{"kind": "initial", "id": "start", "left": 85, "top": 0},
{"kind": "state", "name": "Waiting", "left": 25, "top": 60, "width": 140},
{"kind": "state", "name": "Checking", "left": 25, "top": 180, "width": 140,
"actions": ["entry / reserve stock", "do / wait for payment"]},
{"kind": "final", "id": "end", "left": 83, "top": 340}
],
"relations": [
{"from": "start", "to": "Waiting"},
{"from": "Waiting", "to": "Checking", "name": "order [in stock] / accept"},
{"from": "Waiting", "to": "Waiting", "name": "tick", "via": [[190, 68], [190, 92]]},
{"from": "Checking", "to": "end", "name": "paid"}
]
}
It gets back the same things as the package diagram tool. The check also fails when a line runs through the name and actions of a state it starts or ends in, or a label sits on them.
Activity diagrams
The tool is draw_activity_diagram. It draws start and end points, actions, and decision and merge diamonds joined
by flows. The guard of a flow out of a decision goes in its name, brackets included:
{
"file_name": "order-flow",
"elements": [
{"kind": "initial", "id": "start", "left": 140, "top": 0},
{"kind": "action", "name": "Take order", "left": 95, "top": 60, "width": 110},
{"kind": "decision", "id": "stock?", "left": 135, "top": 150},
{"kind": "action", "name": "Ship", "left": 0, "top": 230},
{"kind": "action", "name": "Restock", "left": 200, "top": 230},
{"kind": "merge", "id": "done?", "left": 135, "top": 320},
{"kind": "final", "id": "end", "left": 138, "top": 400}
],
"relations": [
{"from": "start", "to": "Take order"},
{"from": "Take order", "to": "stock?"},
{"from": "stock?", "to": "Ship", "name": "[in stock]", "via": [[45, 165]]},
{"from": "stock?", "to": "Restock", "name": "[out of stock]", "via": [[245, 165]]},
{"from": "Ship", "to": "done?", "via": [[45, 335]]},
{"from": "Restock", "to": "done?", "via": [[245, 335]]},
{"from": "done?", "to": "end"}
]
}
It gets back the same things as the package diagram tool, and checks the same way.
Sequence diagrams
The tool is draw_sequence_diagram. The assistant sends no coordinates: only the participants, the messages in
order, frames (loop, opt, alt) that cover a range of messages, and ref boxes placed before a message.
cysUML spaces the lifelines to fit the text and draws the activation bars:
{
"file_name": "checkout",
"participants": [{"name": "Customer", "kind": "actor"}, {"name": "Shop"}, {"name": "Payment"}],
"messages": [
{"from": "Customer", "to": "Shop", "name": "order()"},
{"from": "Shop", "to": "Payment", "name": "pay(amount)"},
{"from": "Payment", "to": "Shop", "kind": "reply", "name": "receipt"},
{"from": "Shop", "to": "Customer", "kind": "reply"}
],
"frames": [{"kind": "opt", "first": 1, "last": 2, "condition": "paid by card"}]
}
It gets back the check result, the saved file paths, and the picture. As cysUML does the layout, a failed check is a cysUML bug. Each finding still says what to change in the input to get around it: the order of participants or messages, the messages a frame covers, shorter text, or splitting the diagram.
All tools
Saved to
out_dir, ordiagrams/under the server's working folder whenout_diris not given. The samefile_nameoverwrites the picture and its input file (below). Some clients start servers in a folder you can't write to (such as/); the tool then answers with an error, and the assistant should pass anout_dir.Input file
<file_name>.cysuml.jsonis saved next to the picture: the tool name and the input that drew it, withoutout_dir. To change a diagram later, the assistant reads that file, edits it, and draws it again without_dirset to the file's folder; the file as it is draws the same picture. The.cysuml.jsonending keeps it apart from other tools' files such aspackage.json.Returned picture is shrunk to 1568 px on its long side when it is bigger. The saved picture keeps its full size.
The full input format is in each tool's argument descriptions, which your client hands to the assistant.
Develop
uv sync
uv run pytestTo try your working copy in Claude Code, register it under another name:
claude mcp add cysuml-dev -- uv run --directory /path/to/cysUML cysumlTo try the latest main before it is released, use uvx --from git+https://github.com/yschoi9733/cysUML cysuml.
The pictures in this README live in docs/images/ and are drawn with uv run python scripts/readme_images.py. The
example pictures under Use are drawn from the JSON examples above, so run it after changing one. The
before/after pictures at the top are drawn from their input files, docs/images/first-try.cysuml.json and the like:
edit those, then run it.
License
cysUML is under the MIT License. The bundled fonts are
Liberation Sans and Noto Sans KR, both under the SIL Open Font License 1.1 (see
LiberationSans-LICENSE.txt
and NotoSansKR-LICENSE.txt).
한국어
AI가 배치하고 도구가 그리는, 문서용 UML 그림 MCP 서버다.
자동 배치 도구는 상자끼리 겹치지 않게 놓아 주지만, 자리를 도구가 정한다. 원하는 모양으로 놓게 하기 어렵고, 클래스 하나만 더해도 그림 전체가 뒤섞일 수 있고, 글자가 선에 붙어 어수선해지기도 한다. cysUML은 반대로 간다. AI 어시스턴트가 상자 자리를 정하면 cysUML은 그대로 그리고 그림을 검사한다. 어시스턴트가 자리를 직접 잡다 보면 실수가 생기므로, 상자끼리 겹치거나, 선이 상자나 글자를 지나거나, 글자끼리 겹치면 불합격이고 무엇을 옮길지 알려 준다. 어시스턴트는 배치를 고쳐 합격할 때까지 다시 그린다.
여러 UML 그림을 그린다(목록은 아래 쓰기). 교류도는 참여자·메시지 차례를 받아 cysUML이 배치하고, 똑같이 검사한다.
PNG로 낸다. 글꼴을 함께 넣어 어느 컴퓨터에서든 같은 그림이 나오고, 한글도 그린다.
예를 들어 어시스턴트가 처음에 상품을 주문항목 바로 아래, 고객과 결제를 잇는 선 위에 두면, 그 선이 상품 상자 밑으로 지나가
가려진다. 그러면 그림이 모델에 없는 것을 말한다 — 상품은 고객·결제와 관계가 없는데, 낸다가 고객과 상품 사이의 관계처럼
보이고 상품에서 결제로 가는 선이 따로 있는 것처럼 보인다. 검사는 바로 이 한 건으로 불합격시키고 이렇게 알려 준다.
선이 상자를 지난다: 선 고객->결제(relations[3]), 상자 상품(190, 240, 130×93). 그 상자를 옮기거나, 꺾는 점(via)을 고쳐 그 상자를 비켜 가게 한다.

어시스턴트가 알려 준 대로 상품을 주문항목 오른쪽으로 옮기고, 빈자리만큼 결제와 카드결제를 왼쪽으로 당겨 다시 그리자 검사를 통과했다.

설치
uv가 있어야 한다. 아래 한 줄이 PyPI에서 cysUML을 받아 서버를 띄운다:
uvx cysuml표준 입출력으로 MCP를 주고받으므로 혼자 띄우면 클라이언트를 기다리기만 한다. 쓰려면 MCP 클라이언트에 등록한다.
Claude Code:
claude mcp add cysuml -- uvx cysuml다른 클라이언트: 위 영어 안내의 JSON 설정에 같은 명령을 넣는다.
버전:
uvx cysuml은 가장 새 버전을 띄운다. 클라이언트가 서버를 띄울 때마다 uv가 PyPI에 묻고, 받은 답은 10분까지 다시 쓴다.uv tool install cysuml로 설치해 두었으면 uvx는 그 설치본을 띄우니uv tool upgrade cysuml로 올린다. 한 버전에 머물려면 이름 뒤에 버전을 붙인다 —uvx cysuml@0.2.1(JSON에서는"args": ["cysuml@0.2.1"]). 나온 버전은 PyPI 릴리스 기록에 있다.
쓰기
어시스턴트에게 "cysUML로 주문 도메인 클래스도를 그려 줘"나 "결제 흐름을 cysUML 교류도로 그려 줘"처럼 부탁한다. 배치 요령은 서버가 어시스턴트에게 알려 준다.
클래스도는
draw_class_diagram으로 그린다. 어시스턴트가 상자의 왼쪽 위 자리와, 필요하면 관계선의 꺾는 점을 준다. 결과로 검사 결과, 상자마다 그린 자리와 크기, 저장한 그림·입력 파일 경로, 그림을 돌려준다. 상자끼리 겹치거나, 선이 상자·글자·다른 선의 화살촉을 지나거나, 글자끼리 겹치면 불합격이다. 관계 이름은 그 관계의 선 위에 얹어 그리고(선은 이름 앞뒤에서 끊긴다), 이름이 얹힌 그 선 구간은 이름을 지나는 것으로 치지 않는다(같은 선의 다른 구간·선 끝 모양과 다른 선은 친다). 선 위에 빈 자리가 없거나(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도) 같은 상자로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 선끼리 엇갈린 곳과 그림 크기는 알려 주기만 하고 불합격이 아니다. 같은 부모로 가는 상속끼리, 실체화끼리는 여러 선을 한 줄기로 모아 삼각형 하나를 함께 써도 된다(꺾는 점을 주는 법은relations인자 설명에 있다). 같은 부모로 상속과 실체화가 함께 오면 결과가 부모에서 선이 향하는 점(보통 가운데) 양옆에 종류마다 향하는 점을 함께 돌려주고, 마지막 꺾는 점을 그 선과 같은 종류의 점 바로 아래에 둔 선은 그 점으로 곧게 올라가 두 삼각형이 나란히 놓인다. 삼각형 둘이 나란히 들지 않는 좁은 부모(48px보다 좁게 그려진 클래스, 다른 도구의 문서 아이콘 아티팩트)에는 점이 붙지 않는다. 관계는 UML 표기를 따라야 하고, 어기면 그리지 않고 입력 오류로 돌려준다 — 상속은 같은 종류끼리(클래스와 추상 클래스는 같은 종류) 긋고, 고리를 이루거나 자기 자신으로 가는 상속·실체화는 받지 않는다. 인터페이스가 하는 실체화와 인터페이스가 아닌 것으로 가는 실체화는 그리되 알림을 준다. 패키지도·컴포넌트도·배치도(deployment diagram)도 같은 규칙을 쓴다. 거기서 패키지와 제공 인터페이스 원은 상속의 끝이 될 수 없고, 둘이 하는 실체화에는 알림을 주며, 클래스가 컴포넌트를 실현하는 실체화에는 알림을 주지 않는다. 아이콘 표기 컴포넌트·아티팩트는 기본 표기와 같은 종류로 친다.패키지도는
draw_package_diagram으로 그린다. 패키지와 패키지 사이 의존을 그리고, 패키지 안에 클래스·패키지를 넣는다. 컴포넌트·아티팩트·노드도 한 그림에 함께 그린다. 요소마다kind를 주고, 다른 요소 안에 둘 요소는in으로 품은 요소를 가리킨다 — 바깥 요소는 안의 요소를 덮도록 오른쪽·아래로 늘어난다. 결과는 클래스도와 같고 요소마다 그린 자리를 돌려준다(패키지는 선이 가운데가 아니라 탭 오른쪽 몸통의 가운데를 향하므로 그 점도 함께). 클래스도 검사에 더해, 안의 요소가 바깥 요소의 테두리·이름 탭에 붙거나, 선이 그 끝을 품은 패키지의 테두리를 따라가거나 패키지 탭을 지나면 불합격이다. 컴포넌트·아티팩트는 아이콘 표기로도 그린다 —component_icon은 왼쪽 변에 작은 네모 둘이 걸친 UML 1 표기 컴포넌트(선이 네모를 지나면 불합격),artifact_icon은 귀 접힌 문서 아이콘과 그 밖(name_side)에 쓰는 이름이다.컴포넌트도는
draw_component_diagram으로 그린다. 컴포넌트와 제공 인터페이스, 컴포넌트를 구현하는 아티팩트, 컴포넌트를 실현하는 클래스를 그린다. 패키지도 도구가 받는 요소(아이콘 표기 포함)에 더해lollipop(제공 인터페이스 원 — 작은 원과 그 밖에 쓰는 이름으로 그린다. 이름 쪽은name_side)을 받는다. 제공하는 컴포넌트는 원과association으로 잇고(이 도구에서는navigable을 주지 않으면 화살촉이 없다), 쓰는 쪽은 원으로dependency를 긋는다. 결과는 패키지도와 같고, 원마다 원만의 자리도 함께 돌려준다. 검사도 같고, 선이 원이나 그 이름을 지나면 불합격이다. 쓰는 쪽은 소켓으로도 그린다 — 쓰는 쪽에서 원으로requires를 그으면 실선이 원 앞에서 멈추고 그 끝에 원을 감싸는 반원이 붙는다.to는 원이어야 하고from은 원이 아니어야 한다. 한 원에 소켓은 하나이고(반원 둘은 겹친다), 다른 쓰는 쪽은dependency로 원을 가리킨다. 반원에 닿는 선은 불합격이다. 아이콘 표기 컴포넌트·아티팩트와 소켓을 함께 쓴 그림이 위 영어 절의billing예시다.배치도(deployment diagram)는
draw_deployment_diagram으로 그린다. 소프트웨어(컴포넌트·아티팩트)가 어느 컴퓨터(노드)에서 도는지 보인다. 노드 안에 컴포넌트·아티팩트·노드를in으로 넣고, 노드끼리는 통신 경로(association—name에 HTTPS 같은 프로토콜)로 잇고, 노드 밖 요소에서 노드로 «deploy»(stereotype이deploy인dependency)를 긋는다. 이 도구는 클래스끼리 이은 것까지 모든 연관을 화살촉 없는 실선으로 그린다(필요하면navigable을 준다). 받는 요소(아이콘 표기 포함)·결과·검사는 패키지도와 같다.유즈케이스도는
draw_use_case_diagram으로 그린다. 액터·유즈케이스·시스템 경계를 그리고, 연관·의존(«include»·«extend»)· 일반화로 잇는다. 유즈케이스는in으로 시스템 경계 안에 넣고, 액터는 경계 밖에 두어 이름을 사람 모양 옆(name_side가 정한 쪽)에 쓴다. 결과는 패키지도와 같고, 액터는 이름까지 덮는 자리 뒤에 사람 모양 자리를 함께 돌려준다. 검사는 패키지도와 같고, 선이 액터 이름이나 시스템 경계 이름을 지나도 불합격이다. 같은 부모로 가는 일반화 선은 클래스도의 상속처럼 한 줄기로 모아도 된다. 요소와 관계는 UML 표기를 따라야 하고, 어기면 그리지 않고 입력 오류로 돌려준다 — 액터는 시스템 경계 밖에 두고, 시스템 경계에는 어떤 관계도 잇지 않는다. 연관은 액터와 유즈케이스 사이나 경계가 다른 유즈케이스 사이(서로 다른 경계이거나 한쪽만 경계 안)에 긋고, 액터끼리나 같은 시스템 경계 안이거나 둘 다 경계 밖인 유즈케이스끼리는 잇지 않는다. 일반화는 액터끼리·유즈케이스끼리 고리를 이루거나 자기 자신으로 가지 않게 긋는다. «include»·«extend»는 유즈케이스 사이의 의존에만 달고, 유즈케이스는 자기 자신을 포함하거나 확장하지 않으며, «include»끼리·«extend»끼리는 고리를 이루지 않는다.상태도는
draw_state_diagram으로 그린다. 시작·끝 점, 상태, 선택 마름모를 전이로 잇는다. 상태의entry /·do /·exit /줄은actions에 주면 받은 그대로 쓰고, 상태 안에 상태를 넣을 때는in으로 품은 상태를 가리킨다. 이름이 없는 시작·끝 점과 선택은id를 주어 전이가 가리키게 한다. 전이 글자(name)도 대괄호·빗금까지 받은 그대로 쓴다. 결과는 패키지도와 같다. 선이 그 끝을 품은 상태의 이름·동작 칸을 지나거나 전이 글자가 그 칸에 겹쳐도 불합격이다.액티비티도는
draw_activity_diagram으로 그린다. 시작·끝 점, 행동, 결정·합류 마름모를 흐름으로 잇는다. 결정에서 나가는 흐름의 조건은name에 대괄호까지 쓴다. 결과와 검사는 패키지도와 같다.교류도는
draw_sequence_diagram으로 그린다. 어시스턴트는 좌표 없이 참여자, 메시지 차례, 메시지 범위를 덮는 프레임(loop·opt·alt), 메시지 앞에 놓는ref만 준다. cysUML이 글자에 맞춰 생명선을 띄우고 활성 막대를 그린다. 결과로 검사 결과, 저장한 그림·입력 파일 경로, 그림을 돌려준다. 배치를 cysUML이 하므로 불합격은 cysUML의 버그다. 그래도 항목마다 입력에서 무엇을 바꾸면 비켜 가는지(참여자·메시지 차례, 프레임이 덮는 범위, 글자 줄이기, 그림 나누기) 알려 준다.입력 형식 전체는 도구의 인자 설명에 있어 클라이언트가 어시스턴트에게 넘긴다.
그림은
out_dir에, 없으면 서버 작업 폴더 아래diagrams/에 저장한다. 같은file_name이면 그림과 아래 입력 파일을 둘 다 덮어쓴다. 쓸 수 없는 폴더(/등)에서 서버를 띄우는 클라이언트도 있는데, 그때는 도구가 오류로 알리므로out_dir을 주면 된다.그림 옆에 그린 도구 이름과 입력(
out_dir만 빼고)을<file_name>.cysuml.json으로 함께 저장한다. 나중에 그림을 고칠 때는 어시스턴트가 그 파일을 읽어 고친 뒤,out_dir에 그 파일이 있는 폴더를 주어 다시 그린다. 파일을 그대로 넣으면 같은 그림이 나온다. 끝을.cysuml.json으로 해서package.json같은 다른 도구의 파일과 이름이 겹치지 않는다.돌려주는 그림은 긴 변이 1568px를 넘으면 그 길이로 줄인다. 저장한 그림은 원래 크기다.
개발
uv sync로 준비하고 uv run pytest로 테스트한다. 작업 중인 코드를 Claude Code에서 써 보려면 다른 이름으로 등록한다:
claude mcp add cysuml-dev -- uv run --directory /path/to/cysUML cysuml. 아직 배포하지 않은 main의 최신 코드를 써 보려면
uvx --from git+https://github.com/yschoi9733/cysUML cysuml로 띄운다.
이 README의 그림은 docs/images/에 있고 uv run python scripts/readme_images.py로 그린다. 그림 도구마다 붙은 예시 그림은 영어
안내 Use 절의 JSON 예시로 그리므로, 그 예시를 고쳤으면 다시 돌린다. 맨 위 전후 그림은 docs/images/first-try.cysuml.json
같은 입력 파일로 그리므로, 그 파일을 고친 뒤 돌린다.
라이선스
cysUML은 MIT 라이선스를 따른다. 함께 넣은 글꼴 Liberation Sans와
Noto Sans KR은 SIL Open Font License 1.1을 따른다(src/cysuml/fonts).
Available Tools
8 toolsdraw_activity_diagramA
액티비티도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 시작·끝 점, 행동, 결정·합류 마름모를 흐름으로 잇는다. 요소는 준 왼쪽 위(left·top) 그대로, 흐름은 준 꺾는 점(via)을 따라 그리고, 요소 크기·선 끝·흐름 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 요소마다 그린 자리(열쇠와 왼, 위, 폭×높이), 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 자리를 그대로 다음 입력에 넣으면 요소가 움직이지 않는다.
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
elements·relations·file_name이 틀리면 그리지 않고 틀린 곳을 elements[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 시작 점으로 들어오거나 끝 점에서 나가는 흐름은 그 밖의 입력이 맞을 때 따로 모아 알린다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 요소나 글자를 지나는 등 문서에 넣을 수 없는 그림) 11가지: 요소끼리 겹치거나 붙음, 선이 그 선과 상관없는 요소를 지나감, 선이 끝 요소 테두리에 붙어 감, 선 끝 모양이 그 선의 다른 끝 요소 테두리에 붙음, 선 끝 모양이 그 끝의 요소 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 요소에 겹침, 선 글자끼리 겹침.
액티비티도 배치 요령:
시작 점을 위에 두고, 흐름이 위에서 아래로 흐르게 행동을 한 줄로 놓는다.
결정 마름모에서 갈라지는 갈래는 행동을 옆으로 벌려 놓고, 합류 마름모를 갈래 아래 가운데에 두어 다시 모은다. 갈래로 가는 흐름은 마름모 왼쪽·오른쪽 꼭짓점에서 나가 갈래 행동 위에서 꺾어 내려가게, 갈래에서 합류로 오는 흐름은 갈래 행동 아래에서 꺾어 합류 마름모의 왼쪽·오른쪽 꼭짓점으로 들어오게 꺾는 점(via)을 하나씩 준다(가로·세로 선은 마름모 꼭짓점에 닿는다).
결정에서 나가는 흐름에는 name에 "[조건]"을 쓴다.
되돌아가는 흐름(반복)은 꺾는 점(via)으로 행동들 바깥을 돌게 한다 — 곧게 그으면 가는 흐름과 포개지거나 다른 행동을 지난다.
요소 사이는 흐름 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
요소 크기는 도구가 글자에 맞춰 늘린다. 그린 크기는 결과의 "요소 자리"에서 보고 다음 입력에 쓴다.
Inputs: elements (required), file_name (required), scale, out_dir, +1 more.
draw_class_diagramA
클래스도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 상자는 준 왼쪽 위(left·top) 그대로, 관계선은 준 꺾는 점(via)을 따라 그리고, 상자 크기·선 끝·선 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 상자마다 그린 자리와 크기, 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 같은 부모로 상속·실체화가 함께 오는 상자는 그 상자의 자리 뒤에 종류마다 향하는 점을 "상속 향하는 점 x, y, 실체화 향하는 점 x, y"로 덧붙인다(마지막 꺾는 점 — 꺾는 점이 없으면 자식 가운데 — 이 그 점 바로 아래인 그 종류의 선이 그 점을 향한다. 공유 줄기를 종류마다 그 점으로 모을 때 쓴다. 모양이 좁아 두 종류의 삼각형이 나란히 들지 않으면 덧붙지 않는다).
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
classes·relations·file_name이 틀리면 그리지 않고 틀린 곳을 classes[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 상자나 글자를 지나는 등 문서에 넣을 수 없는 그림) 11가지: 상자끼리 겹치거나 붙음, 선이 그 선과 상관없는 상자를 지나감, 선이 끝 상자 변에 붙어 감, 선 끝 모양이 그 선의 다른 끝 상자 변에 붙음, 선 끝 모양이 그 끝의 상자 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 상자에 겹침, 선 글자끼리 겹침.
클래스도 배치 요령:
연결이 가장 많은 클래스를 가운데에 둔다.
상속·실체화는 부모를 위에, 자식들을 그 아래 한 줄에 둔다.
엇갈림이나 불합격이 나오면 먼저 상자 순서와 자리를 바꾸고, 그래도 안 되면 꺾는 점(via)을 준다.
상자 사이는 관계 이름·다중도 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
상자 크기는 도구가 글자에 맞춰 늘린다(폭은 90px 이상). 그린 크기는 결과의 "상자 자리"에서 보고 다음 입력에 쓴다.
Inputs: classes (required), file_name (required), scale, out_dir, +1 more.
draw_component_diagramA
컴포넌트도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 컴포넌트와 제공 인터페이스 원, 컴포넌트를 구현하는 아티팩트, 컴포넌트를 실현하는 클래스를 그린다. 클래스·패키지·컴포넌트·아티팩트·노드와 제공 인터페이스 원을 한 그림에 섞어 그릴 수 있고, 컴포넌트·아티팩트는 아이콘 표기로도 그린다. 요소는 준 왼쪽 위(left·top) 그대로, 관계선은 준 꺾는 점(via)을 따라 그리고, 요소 크기·선 끝·선 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 요소마다 그린 자리(열쇠와 왼, 위, 폭×높이), 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 자리를 그대로 다음 입력에 넣으면 요소가 움직이지 않는다. 모양 밖 이름이 있는 요소의 자리는 모양과 이름을 함께 덮고, 그 뒤에 모양 자리를 "모양 왼, 위, 폭×높이"로 덧붙인다(꺾는 점을 모양 둘레에 줄 때 쓴다). 선이 모양 가운데에서 비켜난 점을 향하는 요소(kind "package"·"component_icon")는 그 뒤에 그 점을 "향하는 점 x, y"로 덧붙인다(꺾는 점을 그 점의 위아래나 옆에 줄 때 쓴다). 같은 부모로 상속·실체화가 함께 오는 요소는 그 요소의 자리 뒤에 종류마다 향하는 점을 "상속 향하는 점 x, y, 실체화 향하는 점 x, y"로 덧붙인다(마지막 꺾는 점 — 꺾는 점이 없으면 자식 가운데 — 이 그 점 바로 아래인 그 종류의 선이 그 점을 향한다. 공유 줄기를 종류마다 그 점으로 모을 때 쓴다. 모양이 좁아 두 종류의 삼각형이 나란히 들지 않으면 덧붙지 않는다).
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
elements·relations·file_name이 틀리면 그리지 않고 틀린 곳을 elements[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 요소나 글자를 지나는 등 문서에 넣을 수 없는 그림) 14가지: 요소끼리 겹치거나 붙음, 안의 요소가 바깥 요소의 칸 밖으로 나가거나 테두리·이름 칸에 붙음, 선이 그 선과 상관없는 요소를 지나감, 선이 끝 요소의 몸통 밖 자리(이름 칸 등)나 끝을 품은 요소의 이름 칸을 지나감, 선이 끝을 품은 요소의 테두리를 따라감, 선이 끝 요소 테두리에 붙어 감, 선 끝 모양이 그 선의 다른 끝 요소 테두리에 붙음, 선 끝 모양이 그 끝의 요소 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 요소에 겹침, 선 글자끼리 겹침.
컴포넌트도 배치 요령:
제공 인터페이스는 원(lollipop)으로 그린다 — 제공하는 컴포넌트에서 원으로 association을 긋고(이 도구의 연관 기본 방향은 "none"이라 화살촉 없는 막대가 된다), 그 인터페이스를 쓰는 쪽에서 원으로 dependency(점선 화살표)나 requires(소켓)를 긋는다. 한 원을 여럿이 쓸 수 있다.
원은 제공하는 컴포넌트 바로 옆, 쓰는 쪽을 향한 쪽에 둔다. 컴포넌트가 패키지 안에 있으면 원도 in으로 그 패키지 안에 넣는다.
원으로 들어오는 화살표는 한 점에 몰리지 않게 원 둘레로 흩어 둔다 — 원 가운데에서 본 쓰는 쪽(꺾는 점을 주면 마지막 꺾는 점)의 방향이 다른 쓰는 쪽과도, 막대(제공하는 컴포넌트 쪽)와도 40°쯤 넘게 벌어지게 한다. 더 좁으면 화살촉끼리 겹치거나 화살촉이 막대에 닿아 불합격이다.
소켓은 한 원에 하나다 — 반원 둘은 겹쳐 불합격이다. 그 원을 쓰는 나머지 쪽은 dependency 화살표로 긋거나, 같은 인터페이스의 원을 하나 더 그린다. 반원이 원의 쓰는 쪽 절반을 감싸므로 막대와 화살표는 열린 쪽에서 들어온다 — 원 가운데에서 본 소켓 쪽(꺾는 점을 주면 마지막 꺾는 점)과 막대는 100°, 화살표는 110° 넘게 벌린다. 막대를 소켓 맞은편에 두어 막대·원·소켓을 일직선으로 그으면 가장 넉넉하다.
원 이름은 막대와 들어오는 화살표·소켓이 없는 쪽에 쓴다(name_side, 기본은 아래) — 쓰는 쪽이 아래면 이름을 옆에 쓰고, 막대·원·소켓이 가로 일직선이면 위나 아래에 쓴다.
컴포넌트·아티팩트를 아이콘 표기(component_icon·artifact_icon)로 그려도 요령은 같다. 문서 아이콘 아티팩트에서 그 아티팩트가 구현하는 컴포넌트로는 stereotype(예: "manifest")을 단 dependency를 긋고, 아티팩트 이름은 그 선이 없는 쪽(name_side)에 쓴다. UML 1 표기 컴포넌트에는 왼쪽 변의 부품 네모 사이로 가로선 하나만 들어오므로, 그 컴포넌트와 잇는 나머지 원·아티팩트·요소는 위·아래·오른쪽에 둔다.
패키지마다 그 안의 컴포넌트를 묶어 둔다. 패키지 안 요소와 밖 요소를 잇는 선의 글자(«manifest» 등)는 도구가 선을 따라 패키지 테두리를 비킨 자리에 놓으니, 밖 요소는 패키지와 그 글자가 들어갈 만큼 띄운다 — 옆이면 가장 긴 줄의 글자 폭 + 15px, 아래·위면 글자 줄 수 × 15 + 가장 긴 줄의 글자 폭 ÷ 4 + 25px 이상이다. 글자 폭은 영문·숫자·ASCII 기호 한 글자 11px(W·@·%는 14px), 한글 12px, 그 밖의 글자 14px로 넉넉히 어림하고, 불합격 항목에 글자 자리(폭×높이)가 나오면 그 폭으로 고친다.
아티팩트는 구현하는 컴포넌트 가까이 두고, 아티팩트에서 컴포넌트로 stereotype "manifest"를 단 dependency를 긋는다.
컴포넌트를 실현하는 클래스들(패키지 안에 둘 수 있다)은 컴포넌트 아래에 두고, 클래스에서 컴포넌트로 realization을, 또는 컴포넌트에서 클래스로 dependency를 긋는다. 클래스 사이 관계 종류는 클래스도와 같다. 다만 연관·집합·합성의 기본 방향이 클래스도 ("to")와 달리 "none"이라 화살촉이 없으니, 화살촉이 필요하면 navigable을 준다.
요소 사이는 관계 이름·스테레오타입 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
요소 크기는 도구가 글자와 안의 요소에 맞춰 늘린다. 그린 크기는 결과의 "요소 자리"에서 보고 다음 입력에 쓴다.
Inputs: elements (required), file_name (required), scale, out_dir, +1 more.
draw_deployment_diagramA
배치도(deployment diagram)를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 소프트웨어(컴포넌트·아티팩트)가 어느 컴퓨터(노드)에 놓여 도는지 보인다. 노드 안에 컴포넌트·아티팩트·노드를 넣고, 노드끼리 통신 경로를, 노드 밖 요소에서 노드로 «deploy»를 긋는다. 컴포넌트·아티팩트는 아이콘 표기로도 그리고, 클래스·패키지 요소도 한 그림에 섞어 그릴 수 있다. 요소는 준 왼쪽 위(left·top) 그대로, 관계선은 준 꺾는 점(via)을 따라 그리고, 요소 크기·선 끝·선 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 요소마다 그린 자리(열쇠와 왼, 위, 폭×높이), 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 자리를 그대로 다음 입력에 넣으면 요소가 움직이지 않는다. 모양 밖 이름이 있는 요소의 자리는 모양과 이름을 함께 덮고, 그 뒤에 모양 자리를 "모양 왼, 위, 폭×높이"로 덧붙인다(꺾는 점을 모양 둘레에 줄 때 쓴다). 선이 모양 가운데에서 비켜난 점을 향하는 요소(kind "package"·"component_icon")는 그 뒤에 그 점을 "향하는 점 x, y"로 덧붙인다(꺾는 점을 그 점의 위아래나 옆에 줄 때 쓴다). 같은 부모로 상속·실체화가 함께 오는 요소는 그 요소의 자리 뒤에 종류마다 향하는 점을 "상속 향하는 점 x, y, 실체화 향하는 점 x, y"로 덧붙인다(마지막 꺾는 점 — 꺾는 점이 없으면 자식 가운데 — 이 그 점 바로 아래인 그 종류의 선이 그 점을 향한다. 공유 줄기를 종류마다 그 점으로 모을 때 쓴다. 모양이 좁아 두 종류의 삼각형이 나란히 들지 않으면 덧붙지 않는다).
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
elements·relations·file_name이 틀리면 그리지 않고 틀린 곳을 elements[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 요소나 글자를 지나는 등 문서에 넣을 수 없는 그림) 14가지: 요소끼리 겹치거나 붙음, 안의 요소가 바깥 요소의 칸 밖으로 나가거나 테두리·이름 칸에 붙음, 선이 그 선과 상관없는 요소를 지나감, 선이 끝 요소의 몸통 밖 자리(이름 칸 등)나 끝을 품은 요소의 이름 칸을 지나감, 선이 끝을 품은 요소의 테두리를 따라감, 선이 끝 요소 테두리에 붙어 감, 선 끝 모양이 그 선의 다른 끝 요소 테두리에 붙음, 선 끝 모양이 그 끝의 요소 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 요소에 겹침, 선 글자끼리 겹침.
배치도(deployment diagram) 자리 잡기 요령:
사용자 쪽 노드(PC·휴대폰 등)를 한쪽 끝에, 서버·데이터베이스 노드를 다른 쪽으로 차례로 놓아 통신 경로가 엇갈리지 않게 한다.
통신 경로는 두 노드의 가운데를 잇는다. 가로 한 줄에 놓은 노드는 top과 height를, 세로 한 단에 쌓은 노드는 left와 width를 같게 주면 경로가 곧다. 노드는 안의 요소에 맞춰 늘어나니, 결과의 "요소 자리"에서 그 줄(단)의 가장 높은(넓은) 노드 크기를 다른 노드의 height(width)로 준다. 안의 요소를 바꿔 노드가 다시 늘면 다시 맞춘다.
노드 안의 요소는 이름 한 줄 노드면 노드 top + 52부터 두고, 스테레오타입(«device» 등)이나 이름 줄이 하나 늘 때마다 14px씩 더 아래부터 둔다(«device» 노드면 top + 66, 이름이 두 줄인 «device» 노드면 top + 80).
노드 밖에서 노드 안의 요소(노드 안의 노드 포함 — 아래에서 "끝 요소")로 가는 선이 끝 요소를 품은 노드들의 이름(앞면 위 가운데)을 지나면 불합격이다. 선을 보내는 요소는 가장 바깥 노드의 옆에 끝 요소와 같은 높이로(보내는 요소의 top을 끝 요소의 윗변과 아랫변 사이에) 두거나, 아래에 끝 요소와 같은 가로 자리로(보내는 요소의 left를 끝 요소의 왼변과 오른변 사이에) 둔다. 왼쪽·오른쪽·아래 가운데 노드 테두리에서 끝 요소까지 가는 길에 다른 요소가 없는 쪽을 고른다. 그 선의 글자(«deploy»·프로토콜 이름)는 도구가 선을 따라 노드 테두리를 비킨 자리에 놓으니, 가장 바깥 노드와는 그 글자가 들어갈 만큼 띄우면 된다 — 옆이면 가장 긴 줄의 글자 폭 + 15px, 아래·위면 글자 줄 수 × 15 + 가장 긴 줄의 글자 폭 ÷ 4 + 25px 이상이다. 글자 폭은 영문·숫자·ASCII 기호 한 글자 11px(W·@·%는 14px), 한글 12px, 그 밖의 글자 14px로 넉넉히 어림하고, 불합격 항목에 글자 자리(폭×높이)가 나오면 그 폭으로 고친다. 어림은 넉넉한 값이라, «deploy» 한 줄은 실제로는 요소 사이 기본 간격("요소 사이는" 항목)에도 들어간다.
끝 요소가 가장 바깥 노드 바로 안의 노드이면 선을 보내는 요소를 위에 둘 수도 있다. 이름 칸 바로 위는 피하고, 이름 칸에서 보내는 요소 쪽으로 40px쯤 바깥, 이름 칸 아랫변에서 10px 아래에 꺾는 점(via)을 하나 준다(이름 칸 옆 앞면이 40px보다 좁아 꺾는 점이 앞면 밖(두께 띠나 노드 밖)에 놓여도 된다. 이름 칸 자리는 불합격 항목의 "이름 칸"에 나온다). 보내는 요소가 바깥 노드 오른쪽 위 모서리 근처라 꺾는 점까지 가는 선이 그 모서리의 비스듬한 두께 띠 선을 따라가 불합격하면, 보내는 요소를 옆으로 20px쯤 옮긴다. 끝 요소가 더 깊으면 위에 두지 않는다 — 이 꺾는 점으로는 안쪽 노드의 이름을 비키지 못한다.
요소 사이는 관계 이름·스테레오타입 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
요소 크기는 도구가 글자와 안의 요소에 맞춰 늘린다. 그린 크기는 결과의 "요소 자리"에서 보고 다음 입력에 쓴다.
Inputs: elements (required), file_name (required), scale, out_dir, +1 more.
draw_package_diagramA
패키지도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 패키지와 패키지 사이 의존을 그리고, 패키지 안에 클래스·패키지를 넣는다. 클래스·패키지·컴포넌트·아티팩트·노드를 한 그림에 섞어 그릴 수 있고, 컴포넌트·아티팩트는 아이콘 표기로도 그린다. 요소는 준 왼쪽 위(left·top) 그대로, 관계선은 준 꺾는 점(via)을 따라 그리고, 요소 크기·선 끝·선 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 요소마다 그린 자리(열쇠와 왼, 위, 폭×높이), 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 자리를 그대로 다음 입력에 넣으면 요소가 움직이지 않는다. 모양 밖 이름이 있는 요소의 자리는 모양과 이름을 함께 덮고, 그 뒤에 모양 자리를 "모양 왼, 위, 폭×높이"로 덧붙인다(꺾는 점을 모양 둘레에 줄 때 쓴다). 선이 모양 가운데에서 비켜난 점을 향하는 요소(kind "package"·"component_icon")는 그 뒤에 그 점을 "향하는 점 x, y"로 덧붙인다(꺾는 점을 그 점의 위아래나 옆에 줄 때 쓴다). 같은 부모로 상속·실체화가 함께 오는 요소는 그 요소의 자리 뒤에 종류마다 향하는 점을 "상속 향하는 점 x, y, 실체화 향하는 점 x, y"로 덧붙인다(마지막 꺾는 점 — 꺾는 점이 없으면 자식 가운데 — 이 그 점 바로 아래인 그 종류의 선이 그 점을 향한다. 공유 줄기를 종류마다 그 점으로 모을 때 쓴다. 모양이 좁아 두 종류의 삼각형이 나란히 들지 않으면 덧붙지 않는다).
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
elements·relations·file_name이 틀리면 그리지 않고 틀린 곳을 elements[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 요소나 글자를 지나는 등 문서에 넣을 수 없는 그림) 14가지: 요소끼리 겹치거나 붙음, 안의 요소가 바깥 요소의 칸 밖으로 나가거나 테두리·이름 칸에 붙음, 선이 그 선과 상관없는 요소를 지나감, 선이 끝 요소의 몸통 밖 자리(이름 칸 등)나 끝을 품은 요소의 이름 칸을 지나감, 선이 끝을 품은 요소의 테두리를 따라감, 선이 끝 요소 테두리에 붙어 감, 선 끝 모양이 그 선의 다른 끝 요소 테두리에 붙음, 선 끝 모양이 그 끝의 요소 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 요소에 겹침, 선 글자끼리 겹침.
패키지도 배치 요령:
의존이 위에서 아래로 흐르게 패키지를 층으로 놓는다(쓰는 쪽을 위에, 쓰이는 쪽을 아래에).
패키지 안 클래스는 클래스도 요령을 따른다 — 연결이 많은 클래스를 가운데에, 상속은 부모를 위에 자식을 그 아래 한 줄에 둔다.
위에서 들어오는 의존선은 탭 오른쪽 몸통 윗변에 닿게 한다. 패키지로 오가는 선은 탭 오른쪽 몸통의 가운데를 향하는데, 그 점은 패키지 폭과 이름 길이(탭 폭)에 따라 달라서 위아래로 쌓은 패키지라도 폭이나 이름 길이가 다르면 선이 비스듬히 들어와 아래 패키지 탭을 지나기 쉽다. 그러면 아래 패키지 탭 오른쪽 끝에서 20px쯤 오른쪽, 아래 패키지 top에서 30px쯤 위에 꺾는 점(via)을 하나 준다 (탭 자리는 불합격 항목의 "이름 칸"에 나온다).
요소 사이는 관계 이름·스테레오타입 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
요소 크기는 도구가 글자와 안의 요소에 맞춰 늘린다. 그린 크기는 결과의 "요소 자리"에서 보고 다음 입력에 쓴다.
Inputs: elements (required), file_name (required), scale, out_dir, +1 more.
draw_sequence_diagramA
교류도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 교류도는 도구가 배치한다 — 좌표는 받지 않고, 생명선 간격과 메시지 높이를 글자 폭에 맞춰 정하고 활성 막대를 메시지에서 잇는다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 검사 항목은 메시지·프레임·노트를 입력 안의 자리(messages[3]·frames[0]·notes[0])로, 참여자를 이름으로 가리킨다.
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
입력이 틀리면 그리지 않고 틀린 곳을 messages[2].to 꼴 자리와 함께 모두 모아 오류로 돌려준다. 그림이 너무 커서 PNG로 그릴 수 없거나, 저장할 폴더에 쓸 수 없거나, 도구가 배치하지 못했을 때도 오류로 돌려준다.
교류도 그리는 흐름:
참여자 차례, 메시지 차례, 프레임이 덮는 메시지 범위를 정해 그린다. 좌표는 주지 않는다 — 생명선 간격, 메시지 높이, 활성 막대는 도구가 정한다.
돌려받은 검사 결과와 그림을 본다. 교류도는 도구가 배치하므로 불합격은 cysUML의 배치 버그다. 그래도 그 그림이 필요하면 항목마다 붙은 힌트대로 입력을 바꿔 비켜 간다 — 참여자 순서나 메시지 차례, 프레임이 덮는 범위(first·last·칸·before)를 바꾸거나, 글자를 줄이거나, 그림을 나눈다. 배치하지 못했다는 오류가 와도 같다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 그림 크기는 알림이라 불합격이 아니다. 다만 개수 한도 안이어도 그림이 너무 크면 PNG로 그리지 못해 오류가 되니, 메시지가 많아 그림이 길면 나눈다.
Inputs: file_name (required), participants (required), notes, scale, +3 more.
draw_state_diagramA
상태도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 시작·끝 점, 상태, 선택 마름모를 전이로 잇고, 상태 안에 상태를 넣는다(복합 상태). 요소는 준 왼쪽 위(left·top) 그대로, 전이는 준 꺾는 점(via)을 따라 그리고, 요소 크기·선 끝·전이 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 요소마다 그린 자리(열쇠와 왼, 위, 폭×높이), 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 자리를 그대로 다음 입력에 넣으면 요소가 움직이지 않는다.
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
elements·relations·file_name이 틀리면 그리지 않고 틀린 곳을 elements[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 시작 점으로 들어오거나 끝 점에서 나가는 전이는 그 밖의 입력이 맞을 때 따로 모아 알린다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 요소나 글자를 지나는 등 문서에 넣을 수 없는 그림) 14가지: 요소끼리 겹치거나 붙음, 안의 요소가 바깥 요소의 칸 밖으로 나가거나 테두리·이름 칸에 붙음, 선이 그 선과 상관없는 요소를 지나감, 선이 끝 요소의 몸통 밖 자리(이름 칸 등)나 끝을 품은 요소의 이름 칸을 지나감, 선이 끝을 품은 요소의 테두리를 따라감, 선이 끝 요소 테두리에 붙어 감, 선 끝 모양이 그 선의 다른 끝 요소 테두리에 붙음, 선 끝 모양이 그 끝의 요소 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 요소에 겹침, 선 글자끼리 겹침.
상태도 배치 요령:
시작 점을 위나 왼쪽에 두고, 전이가 한 방향(위에서 아래나 왼쪽에서 오른쪽)으로 흐르게 상태를 차례로 놓는다.
되돌아가는 전이는 꺾는 점(via)으로 상태들 바깥을 돌게 한다 — 곧게 그으면 가는 전이와 포개지거나 다른 상태를 지난다.
같은 상태로 돌아오는 전이(자기 전이)는 상태 오른쪽 변 25px 밖에 꺾는 점 둘(상태 가운데 높이에서 12px 위와 12px 아래)을 준다 — 선이 오른쪽 변에서 비스듬히 나갔다 들어오는 고리가 된다. 윗변 가운데와 오른쪽 변 가운데로 드나드는 다른 전이가 없으면 꺾는 점 셋(상태 가운데 x로 윗변 30px 위, 그 높이로 오른쪽 변 25px 밖, 그 x로 상태 가운데 높이)으로 오른쪽 위 모서리를 도는 네모 고리로 그려도 된다.
선택 마름모로 가는 전이와 거기서 갈라지는 전이는 마름모 꼭짓점으로 곧게 들고 나게 둔다(가로·세로 선은 꼭짓점에 닿는다).
복합 상태 안의 요소는 이름 칸 아래에 둔다. 복합 상태 안의 상태와 밖의 상태를 잇는 전이는 이름 칸을 지나면 불합격이니, 복합 상태의 왼쪽·오른쪽·아래 테두리로 건너게 둔다.
요소 사이는 전이 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
요소 크기는 도구가 글자와 안의 요소에 맞춰 늘린다. 그린 크기는 결과의 "요소 자리"에서 보고 다음 입력에 쓴다.
Inputs: elements (required), file_name (required), scale, out_dir, +1 more.
draw_use_case_diagramA
유즈케이스도를 그려 PNG와 입력 파일로 저장하고, 검사 결과와 그림을 함께 돌려준다. 액터·유즈케이스·시스템 경계를 그리고, 그 사이를 연관·의존(«include»·«extend»)·일반화로 잇는다. 요소는 준 왼쪽 위(left·top) 그대로, 관계선은 준 꺾는 점(via)을 따라 그리고, 요소 크기·선 끝·선 글자 자리만 도구가 정한다. 좌표는 px이고 y는 아래로 커진다.
입력 필드는 인자마다 붙은 설명에 있다.
결과
글: 검사 결과, 요소마다 그린 자리(열쇠와 왼, 위, 폭×높이), 저장한 그림·입력 파일 경로와 그림 픽셀 크기. 자리를 그대로 다음 입력에 넣으면 요소가 움직이지 않는다. 모양 밖 이름이 있는 요소의 자리는 모양과 이름을 함께 덮고, 그 뒤에 모양 자리를 "모양 왼, 위, 폭×높이"로 덧붙인다(꺾는 점을 모양 둘레에 줄 때 쓴다).
그림: 저장한 PNG. 긴 변이 1568px를 넘으면 그 길이로 줄여 돌려준다(저장한 그림은 줄이지 않는다).
입력 파일: 그림 옆 <file_name>.cysuml.json에 그린 도구 이름(tool)과 이 입력(out_dir만 빼고)을 저장한다. 있던 그림을 고칠 때는 이 파일을 읽어 고친 뒤 out_dir에 그 폴더를 주어 tool의 도구로 다시 그린다 — 그대로 넣으면 같은 그림이 나온다(tool은 도구가 무시한다).
elements·relations·file_name이 틀리면 그리지 않고 틀린 곳을 elements[0].left 꼴 자리와 함께 모두 모아 오류로 돌려준다. 그림이 너무 커서 PNG로 그릴 수 없거나 저장할 폴더에 쓸 수 없을 때도 오류로 돌려준다.
AI가 배치하는 그림(클래스도·패키지도 등)을 그리는 흐름 — 검사에 합격할 때까지 되풀이한다:
요소(클래스도에서는 상자)의 자리(left·top)와, 필요하면 관계선의 꺾는 점(via)을 정해 그린다.
돌려받은 검사 결과와 그림을 본다. 불합격 항목마다 걸린 요소, 자리(논리 좌표 왼, 위, 폭×높이), 고치는 법이 붙는다. 고치는 법은 종류마다 다르니(요소를 옮긴다, 꺾는 점을 고친다, 두 요소를 떼어 놓는다 등) 항목에 적힌 대로 고친다.
고친 입력을 같은 file_name으로 다시 그린다(파일을 덮어쓴다). 관계 이름은 도구가 그 관계의 선 위에 얹는다(이름 앞뒤로 선이 끊긴다). 얹을 빈 자리가 없는 이름(선이 짧아 이름 앞이나 뒤에 선이 거의 보이지 않을 때도)과 같은 요소로 돌아오는 선의 이름은 선 옆에 두고, 얹으면 그림 전체에서 걸리는 곳이 더 많아질 때는 모든 이름을 선 옆에 둔다. 다중도는 선 끝 옆에 둔다. 선끼리 엇갈린 곳, 표기 규칙 알림(관계 규칙이 있는 도구에서 뜻을 확인해 볼 관계), 그림 크기는 알림이라 불합격이 아니다. 다만 엇갈림은 적을수록 읽기 좋다.
불합격(선이 요소나 글자를 지나는 등 문서에 넣을 수 없는 그림) 14가지: 요소끼리 겹치거나 붙음, 안의 요소가 바깥 요소의 칸 밖으로 나가거나 테두리·이름 칸에 붙음, 선이 그 선과 상관없는 요소를 지나감, 선이 끝 요소의 몸통 밖 자리(이름 칸 등)나 끝을 품은 요소의 이름 칸을 지나감, 선이 끝을 품은 요소의 테두리를 따라감, 선이 끝 요소 테두리에 붙어 감, 선 끝 모양이 그 선의 다른 끝 요소 테두리에 붙음, 선 끝 모양이 그 끝의 요소 안으로 들어감, 선끼리 포개지거나 선이 왔던 길을 되짚음, 선이 선 끝 모양에 닿음, 선 끝 모양끼리 겹침, 선이 선 글자(관계 이름·다중도 등)를 지나감(이름이 얹힌 그 관계의 선 구간은 빼고), 선 글자가 요소에 겹침, 선 글자끼리 겹침.
유즈케이스도 배치 요령:
시스템 경계 안에 유즈케이스를 세로로 늘어놓는다. 포함(«include»)·확장(«extend»)으로 이어지는 유즈케이스는 그 옆에 둔다.
액터는 시스템 경계의 왼쪽과 오른쪽 밖에 두고, 이름은 왼쪽 액터면 왼쪽("left"), 오른쪽 액터면 오른쪽("right")에 쓴다(name_side). 이름을 아래(기본)에 두면 아래쪽 유즈케이스로 가는 연관선과, 아래 자식 액터에서 올라오는 일반화 선이 이름을 지나 불합격하기 쉽다.
액터끼리 일반화는 부모 액터를 위에, 자식 액터를 그 아래에 둔다. 유즈케이스끼리 일반화도 부모를 위에 둔다.
«include»는 기본 유즈케이스에서 포함되는 유즈케이스로, «extend»는 확장하는 유즈케이스에서 기본 유즈케이스로 긋는다 — 둘 다 kind "dependency"에 stereotype을 단다.
요소 사이는 관계 이름·스테레오타입 글자가 들어갈 만큼 띄운다. 가로 80px·세로 60px쯤에서 시작하고, 글자가 길면 더 띄운다.
요소 크기는 도구가 글자와 안의 요소에 맞춰 늘린다. 그린 크기는 결과의 "요소 자리"에서 보고 다음 입력에 쓴다.
Inputs: elements (required), file_name (required), scale, out_dir, +1 more.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 8 tools
Each of the eight tools maps to exactly one UML diagram type (activity, class, package, component, deployment, use case, state, sequence), and the descriptions reinforce the boundary — e.g. sequence explicitly takes no coordinates while the others do. Minor fuzzy edges exist because package/component/deployment diagrams all accept classes and packages, but the primary use case for each remains clearly separable.
All eight tools follow the identical draw_<diagram_type>_diagram pattern with no deviations, camel-free snake_case throughout. An agent can predict the full tool set from the naming scheme alone.
Eight tools sit squarely in the well-scoped 3-15 range, and each one earns its place by covering a distinct diagram type rather than duplicating functionality. There are no obvious utility or wrapper tools padding the list.
The core UML behavioral and structural diagrams are covered, and each tool is self-contained (renders, validates, saves input file and PNG), so there are no lifecycle dead ends. Gaps remain for object, timing, communication, composite structure, and profile diagrams, which an agent cannot produce with this surface but can often approximate with class/state diagrams.
Maintenance
Related MCP Connectors
Draw architecture diagrams, UML, planning boards and clickable wireframes from your AI assistant.
Render, validate, encode/decode PlantUML diagram-as-code; 22 diagram types. Free, no auth.
Create workflow, sequence, architecture, and mind map diagrams via AI assistants.
Create and edit architecture diagrams from your AI agent; get an SVG and a live editable canvas.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to generate UML diagrams from text descriptions using PlantUML, supporting multiple output formats (PNG, SVG, PDF), syntax validation, and diagram source extraction.MIT
- AlicenseAqualityDmaintenanceEnables AI assistants to generate professional UML diagrams (class, use case, activity, sequence) from natural language descriptions, producing editable .drawio files compatible with diagrams.net.7109 npmISC
- AlicenseAqualityBmaintenanceEnables AI coding agents to list, read, create, update, delete, and render PlantUML and Mermaid diagrams, and check them against the actual codebase to detect architecture drift.15108 npm1MIT
- AlicenseAqualityCmaintenanceEnables AI assistants to generate and validate 30+ UML and other diagram types (Mermaid, D2, Graphviz, BPMN, C4, and more) through the Model Context Protocol, returning rendered SVG, PNG, PDF, JPEG, or base64 output via Kroki, PlantUML, and Mermaid backends.4Apache 2.0