Umlout

io.github.dmkorjv1.2.0更新於 Oct 7, 2026

Build Umlout projects: objects with types and fields, relations, and boards that draw them.

已驗證Streamable HTTP可網頁執行Developer ToolsMedia & DesignProductivity & Workflow

概覽

AI 產生的概覽

讓助理透過託管 MCP 端點建立與編輯 Umlout 圖表專案、畫板、物件、關係與圖形。

功能
Umlout 提供託管 MCP 伺服器,包含十二個領域的 95 個工具與 4 個唯讀資源。助理可以建立、讀取、重新命名、公開分享與刪除專案;建立與管理畫板;建立物件、資料夾、關係、型別與欄位;繪製與更新圖形、UML 類別、連接線與時序訊息;上傳檔案;以及處理留言與還原已刪除項目。它也能讀取方案配額與剩餘的速率限制額度。
適用情境
當你希望助理把需求、規格或描述轉成圖表時使用,例如 UML 類別圖、時序圖、活動圖與狀態圖、流程圖、線框圖、敏捷與規劃畫板、平面圖、儀表板與雲端架構圖;也可以讀取既有畫板並回答相關問題。
執行需求
遠端 Streamable HTTP 端點 Umlout 帳號,並在個人資料的 AI 用戶端處建立 API 金鑰,透過 Authorization 標頭以 Bearer 權杖傳送(也可用 X-API-Key)。只接受位址的用戶端可改用瀏覽器登入。Claude Desktop 需要 mcp-remote 橋接與 Node.js。
安裝前請注意
Authorization 標頭攜帶與你帳號綁定的金鑰,助理因此能看到並修改你有權限的專案,包括刪除與還原專案、畫板、物件、關係、型別、欄位與檔案。建議使用不會把金鑰寫入提交到儲存庫的設定檔的用戶端。舊的 SSE 位址在服務重啟後無法使用。有速率限制:每分鐘 300 次工具呼叫、每小時 600 次寫入呼叫,另有每小時 600 次批次寫入。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Umlout,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Web executable,透過 Streamable HTTP。 遠端服務在工作區中設定後即可從網頁執行環境執行。

其他 MCP 客戶端

把它新增到你客戶端的 mcpServers 設定中。

{
  "mcpServers": {
    "umlout": {
      "type": "http",
      "url": "https://www.umlout.com/mcp/http"
    }
  }
}

README

Umlout MCP Server

Let your AI assistant draw on a real whiteboard.

Umlout exposes a hosted Model Context Protocol server, so Claude, Cursor, VS Code Copilot and any other MCP client can build and edit projects in your Umlout workspace — UML class, sequence, activity and state boards, flowcharts, wireframes, agile and planning boards, floor plans, dashboards and cloud architecture drawn with the AWS, Azure and Kubernetes icon sets.

Nothing to install and nothing to run: the server is hosted at https://www.umlout.com/mcp/http (Streamable HTTP). The older SSE address, /mcp/sse, still answers, but an SSE session does not survive a restart of the service, so a client pointed at it fails after every deploy until it is reconnected by hand. Use /mcp/http. You only need an API key.


Quick start

1. Get an API key. Sign in at umlout.com, open Profile → AI clients, pick your client and create a key. The profile page gives the exact text for your client with the key already in it.

2. Add the server to your client.

Claude Code
bash
claude mcp add --transport http umlout https://www.umlout.com/mcp/http --header "Authorization: Bearer YOUR_API_KEY"

More options, including project scope: examples/claude-code.md.

Cursor · VS Code

~/.cursor/mcp.json:

json
{  "mcpServers": {    "umlout": {      "url": "https://www.umlout.com/mcp/http",      "headers": { "Authorization": "Bearer YOUR_API_KEY" }    }  }}

VS Code reads a different shape — servers, not mcpServers, and "type": "http" — so use examples/vscode.json in .vscode/mcp.json. It prompts for the key and keeps it in VS Code's secret storage instead of a committed file.

Claude Desktop — via the mcp-remote bridge

Claude Desktop's config file does not take a remote URL directly, so route it through mcp-remote (needs Node.js). Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

json
{  "mcpServers": {    "umlout": {      "command": "npx",      "args": [        "-y", "mcp-remote", "https://www.umlout.com/mcp/http",        "--header", "Authorization: Bearer YOUR_API_KEY"      ]    }  }}

Then quit Claude Desktop completely and reopen it — closing the window is not enough.

Codex · Gemini CLI · Antigravity · Devin Desktop · other clients

Codex keeps the key out of its config and reads it from an environment variable — see examples/codex.md.

Every other client takes a JSON file with an address and a headers object; only the name of the address field differs:

clientfileaddress field
Cursor~/.cursor/mcp.jsonurl
Gemini CLI~/.gemini/settings.jsonhttpUrl
Antigravity~/.gemini/config/mcp_config.jsonserverUrl
Devin Desktop (formerly Windsurf)its mcp_config.json (MCPs → View raw config)serverUrl
json
{  "mcpServers": {    "umlout": {      "serverUrl": "https://www.umlout.com/mcp/http",      "headers": { "Authorization": "Bearer YOUR_API_KEY" }    }  }}
ChatGPT · Claude connectors · Grok — clients that take only an address

No key: give the client https://www.umlout.com/mcp/http. It opens an Umlout page where you sign in and allow it. See docs/authentication.md.

3. Ask for a board:

Create a project "Auth" and draw a UML sequence diagram of the OAuth2 authorization code flow on a board in it.

Verify your setup at any time:

bash
python3 scripts/check_connection.py --api-key YOUR_API_KEY

What it can do

95 tools across twelve areas, plus 4 read-only resources. Full reference with every argument: docs/tools.md and docs/resources.md.

Umlout stores a project, and a board is one view of it. A project holds objects — each with a name, exactly one type, its own properties and a description — and the relations between them. A figure on a board is one drawing of an object, so the same object can be drawn on five boards and is still one object; a line on a board is one drawing of a relation.

AreaWhat the assistant can do
ProjectsCreate, list, read, rename, share publicly and delete projects
BoardsCreate boards in a project, find them by name, rename, point the camera, clear, delete and restore
Objects and foldersCreate objects, folders and relations in one call; update, merge duplicates, give an object its own detail board
RelationsCreate and update relations with UML detail; reverse a relation's direction
Types and fieldsBrowse the catalogue's types; declare the project's own types; describe each type's fields — text, number, yes/no, choice, markdown, reference, counter, computed, file, list of pairs — and the template an object of the type is drawn with
Shared fieldsDescribe a field once and use it in several types
Shapes and connectionsDraw figures of objects and free figures, UML classes with their compartments, connections with UML notation, sequence messages, custom anchor points; update and delete one at a time or hundreds per call
Composite figures and palettesSave a set of figures as one card and place it again; redraw older copies; arrange the toolbar's palettes
FilesUpload files into a project, rename, delete and restore them; show an image in an Image figure
CommentsAdd, list, resolve and delete comments and replies on any figure or line
Deleted itemsList what was deleted in a project and restore it — a board, an object, a relation, a type, a shared field or a file
Plan and limitsRead the plan's quotas and what is left of the rate-limit budgets

The figure vocabulary covers 205 figures — basic geometry, UML (class, use case, state, activity, sequence, component, deployment, timing), flowchart, charts and dashboard figures, agile and retrospective cards, plans with stages and tasks, floor plans, and a full wireframe kit — plus the AWS, Azure and Kubernetes icon libraries.

Things worth asking for

  • "Turn this OpenAPI spec into a component diagram."
  • "Sketch the mobile onboarding flow as wireframes — three screens."
  • "Read the board 'Checkout' and tell me which states have no outgoing transitions."
  • "Build a project from these requirements: orders, invoices, customers — one type per noun, with their fields — and draw a class board of it."
  • "Add a status field to every Task and count the done ones on each Stage."

Authentication and limits

Every request carries your key in Authorization: Bearer <key> (or X-API-Key), or an OAuth token for a client that signs in through the browser. Both are scoped to your account — the assistant sees exactly the projects you can see, with the role you have in each, and nothing else.

LimitValue
Tool calls300 per minute
Write tool calls600 per hour
Bulk write calls (bulk_*)600 per hour, in addition to the write budget

Details, key rotation and revocation: docs/authentication.md. Something not working? docs/troubleshooting.md.


About this repository

This repo is the public home of the Umlout MCP connector: documentation, client configs, the registry manifest (server.json) and a connection checker. The server itself is a hosted service — there is no local installation, so there is no server source here.

Issues and questions about the MCP integration are welcome in Issues.

License

MIT — documentation and examples.

來源:README.md,提交 3aca44b

工具

0
工具後設資料尚未被收錄。

版本歷史

2
  1. v1.2.0最新Oct 6, 2026
  2. v1.0.0Sep 16, 2026