Skip to content

Commit 77f604c

Browse files
Adds docs for new server C_UD tools.
1 parent ebf4486 commit 77f604c

1 file changed

Lines changed: 37 additions & 2 deletions

File tree

ai/mcp.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,16 @@ It runs standalone and supports stateless HTTP transport.
5858
- View key (required)
5959
- Returns a Structurizr view exported as C4-PlantUML
6060

61-
### -server
61+
### -server-create
62+
63+
#### Create workspace on a Structurizr server
64+
65+
- Parameters
66+
- Structurizr server URL (required)
67+
- API key (not required if running the server with authentication disabled)
68+
- Returns a Structurizr workspace metadata object (workspace name, description, ID, API key, etc)
69+
70+
### -server-read
6271

6372
#### Get workspace from a Structurizr server
6473

@@ -75,6 +84,29 @@ It runs standalone and supports stateless HTTP transport.
7584
- Admin API key (not required if running the server with authentication disabled)
7685
- Returns a collection of Structurizr workspaces
7786

87+
### -server-update
88+
89+
#### Update a workspace on a Structurizr server
90+
91+
This will update the workspace with the supplied DSL, merging layout information from the server version of the workspace.
92+
93+
- Parameters
94+
- Structurizr server URL (required)
95+
- Workspace ID (required)
96+
- API key (not required if running the server with authentication disabled)
97+
- DSL (required)
98+
- Returns true if the workspace was updated
99+
100+
### -server-delete
101+
102+
#### Delete workspace from a Structurizr server
103+
104+
- Parameters
105+
- Structurizr server URL (required)
106+
- Workspace ID (required)
107+
- API key (not required if running the server with authentication disabled)
108+
- Returns true if the workspace was deleted
109+
78110
## mcp.structurizr.com
79111

80112
An instance of the MCP server is running at `mcp.structurizr.com`, with the DSL, PlantUML, and Mermaid tools enabled. If you'd like to use this, just create a connector to `https://mcp.structurizr.com/mcp` in your AI agent.
@@ -91,7 +123,10 @@ docker run -it --rm -p 3000:3000 -e PORT=3000 structurizr/mcp <parameters>
91123
The following parameters are supported:
92124

93125
- `-dsl`: Enable DSL tools.
94-
- `-server`: Enable Structurizr [server](/server) tools.
126+
- `-server-create`: Enable Structurizr [server](/server) create tools.
127+
- `-server-read`: Enable Structurizr [server](/server) read tools.
128+
- `-server-update`: Enable Structurizr [server](/server) update tools.
129+
- `-server-delete`: Enable Structurizr [server](/server) delete tools.
95130
- `-plantuml`: Enable PlantUML exporter.
96131
- `-mermaid`: Enable Mermaid exporter.
97132

0 commit comments

Comments
 (0)