StarUML组件图MCP服务器

面向StarUML组件图的MCP服务器,为AI助手提供组件图资源的完整CRUD与导出能力,适用于在StarUML中自动化构建和维护组件架构模型。

  • by pontasan
  • HTML
  • 本地部署
  • 更新于
在 GitHub 查看 pontasan/staruml-controller-component-mcp

使用说明

StarUML Controller MCP Server — Component Diagram

An MCP (Model Context Protocol) server specialized for Component Diagrams. Enables AI assistants like Claude to programmatically create and manage component diagrams — components, artifacts, component realizations, dependencies, generalizations, and interface realizations in StarUML.

E-Commerce Microservices Architecture — created entirely via MCP tools

Architecture

Prerequisites

Upgrading from 1.x: version 2 needs the staruml-controller extension 2.x, which requires a password. Update the extension, staruml-controller-mcp-core and this package together. Pull and rebuild staruml-controller-mcp-core first, then this package.

Setup

1. Clone and build the core package

git clone https://github.com/pontasan/staruml-controller-mcp-core.git
cd staruml-controller-mcp-core
npm install && npm run build
cd ..

2. Clone and build this package

git clone https://github.com/pontasan/staruml-controller-component-mcp.git
cd staruml-controller-component-mcp
npm install && npm run build

3. Start the StarUML Controller Server

  1. Launch StarUML and open a project (or create a new one)
  2. From the menu bar, select Tools > StarUML Controller > Start Server...
  3. A dialog asks for the port (default: 12345) and the password. A random UUID is filled in as the password automatically; keep it, press Regenerate for a new one, or type your own. Click Start Server
  4. The HTTP server starts and the password is copied to the clipboard, so you can paste it into the MCP server setting (STARUML_PASSWORD). The password is remembered for the next start. To copy it again or to change it, stop the server and open Start Server... again: the dialog shows the password with Copy and Regenerate buttons
  5. All Component Diagram tools become available via MCP

4. Configure your AI assistant

Claude Code — add to your project's .mcp.json:

{
  "mcpServers": {
    "staruml-component": {
      "command": "node",
      "args": ["/absolute/path/to/staruml-controller-component-mcp/dist/index.js"],
      "env": { "STARUML_PASSWORD": "<password>" }
    }
  }
}

Or via CLI:

claude mcp add staruml-component -e STARUML_PASSWORD=<password> -- node /absolute/path/to/staruml-controller-component-mcp/dist/index.js

Claude Desktop — add to your config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "staruml-component": {
      "command": "node",
      "args": ["/absolute/path/to/staruml-controller-component-mcp/dist/index.js"],
      "env": { "STARUML_PASSWORD": "<password>" }
    }
  }
}
  1. Restart your AI assistant.

Available Tools

All tools accept optional host and port parameters. Their defaults come from environment variables of the MCP server:

Variable Required Description
STARUML_PASSWORD Yes The password entered when the StarUML Controller server was started
STARUML_HOST No Host of the machine running StarUML (default: localhost)
STARUML_PORT No Port of the StarUML Controller server (default: 12345)

The password is never a tool parameter, so it does not pass through the AI conversation.

File paths: tools that write or read files (diagram_export, project_export, project_export_all, project_export_doc, project_import) use a path on the machine running this MCP server. save_project and open_project use a path on the machine running StarUML.

Component Diagram Tools

The core of this server — full CRUD for every Component Diagram resource.

Resource Tools
Diagrams component_list_diagrams, component_create_diagram, component_get_diagram, component_update_diagram, component_delete_diagram
Components component_list_components, component_create_component, component_get_component, component_update_component, component_delete_component
Artifacts component_list_artifacts, component_create_artifact, component_get_artifact, component_update_artifact, component_delete_artifact
Component Realizations component_list_component_realizations, component_create_component_realization, component_get_component_realization, component_update_component_realization, component_delete_component_realization
Dependencies component_list_dependencies, component_create_dependency, component_get_dependency, component_update_dependency, component_delete_dependency
Generalizations component_list_generalizations, component_create_generalization, component_get_generalization, component_update_generalization, component_delete_generalization
Interface Realizations component_list_interface_realizations, component_create_interface_realization, component_get_interface_realization, component_update_interface_realization, component_delete_interface_realization

Common Tools

Shared infrastructure tools available across all StarUML Controller MCP servers.

General — status, elements, tags, project I/O
Tool Description
get_status Get server status, version, and endpoint list
get_element Get any element by ID
list_element_tags List tags on an element
create_element_tag Create a tag on an element
get_tag Get tag details
update_tag Update a tag
delete_tag Delete a tag
save_project Save project to a .mdj file
open_project Open a .mdj project file
Project — new, close, import, export
Tool Description
project_new Create a new empty project
project_close Close the current project
project_import Import a .mdj fragment into the project
project_export Export a model fragment to a .mdj file
project_export_all Export all diagrams as images (PNG/SVG/JPEG/PDF)
project_export_doc Export project documentation (HTML/Markdown)
Utility — undo, redo, search, validate, mermaid, generate
Tool Description
undo Undo the last action
redo Redo the last undone action
search Search elements by keyword with optional type filter
validate Run model validation
mermaid_import Import a Mermaid diagram definition
generate_diagram Generate a diagram from natural language (requires AI extension)
Diagrams — CRUD, export, layout, zoom
Tool Description
diagram_list List all diagrams (optionally filter by type)
diagram_create Create a new diagram of any type
diagram_get Get diagram details by ID
diagram_update Update diagram name
diagram_delete Delete a diagram
diagram_list_elements List all elements on a diagram
diagram_list_views List all views on a diagram
diagram_create_element Create a node element on a diagram
diagram_create_relation Create a relation between elements
diagram_export Export diagram as image (PNG/SVG/JPEG/PDF)
diagram_layout Auto-layout diagram with configurable direction
diagram_open Open/activate a diagram in the editor
diagram_zoom Set diagram zoom level
diagram_create_view_of Create a view of an existing model on a diagram
diagram_link_object Create a UMLLinkObject on an object diagram
Notes & Shapes — notes, note links, free lines, shapes
Tool Description
note_list List all notes on a diagram
note_create Create a note with text and position
note_get Get note details
note_update Update note text
note_delete Delete a note
note_link_list List all note links on a diagram
note_link_create Create a link between a note and an element
note_link_delete Delete a note link
free_line_list List all free lines on a diagram
free_line_create Create a free line on a diagram
free_line_delete Delete a free line
shape_list List all shapes on a diagram
shape_create Create a shape (Text, TextBox, Rect, RoundRect, Ellipse, Hyperlink, Image)
shape_get Get shape details
shape_update Update shape text
shape_delete Delete a shape
Views & Elements — positioning, styling, element management
Tool Description
view_update Move/resize a view (left, top, width, height)
view_update_style Update visual style (fillColor, lineColor, fontColor, fontSize, etc.)
view_reconnect Reconnect an edge to different source/target
view_align Align/distribute multiple views
element_update Update any element's name and documentation
element_delete Delete any element by ID
element_list_relationships List all relationships of an element
element_list_views List all views of an element across diagrams
element_relocate Move element to a different parent
element_create_child Create a child element (attribute, operation, etc.)
element_reorder Reorder element within parent (up/down)

Related Projects

This server is part of the StarUML Controller MCP family:

Server Diagram Type
staruml-controller-erd-mcp Entity-Relationship Diagram
staruml-controller-seq-mcp Sequence Diagram
staruml-controller-class-mcp Class / Package Diagram
staruml-controller-usecase-mcp Use Case Diagram
staruml-controller-activity-mcp Activity Diagram
staruml-controller-bpmn-mcp BPMN Diagram
staruml-controller-sysml-mcp SysML Diagram
and 18 more...

All servers share common tools and add diagram-specific tools on top. Install only what you need.

License

MIT