@modudraft/mcp 0.8.0 → 0.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +11 -11
  2. package/dist/index.js +1 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @modudraft/mcp
2
2
 
3
- Model Context Protocol (MCP) server for [Modudraft](https://modudraft.com) the system-design diagramming tool.
3
+ Model Context Protocol (MCP) server for [Modudraft](https://modudraft.com) - the system-design diagramming tool.
4
4
 
5
5
  Connect your AI assistant (Claude, Cursor, Copilot, etc.) to your Modudraft diagrams and let it build and edit architecture, sequence, DB schema, API, cloud, network, and data-flow diagrams for you.
6
6
 
@@ -8,7 +8,7 @@ Connect your AI assistant (Claude, Cursor, Copilot, etc.) to your Modudraft diag
8
8
 
9
9
  ## Requirements
10
10
 
11
- - **Modudraft Pro** account API access is a Pro feature
11
+ - **Modudraft Pro** account - API access is a Pro feature
12
12
  - **Node.js 18+**
13
13
  - An API key from your Modudraft dashboard
14
14
 
@@ -20,7 +20,7 @@ Connect your AI assistant (Claude, Cursor, Copilot, etc.) to your Modudraft diag
20
20
 
21
21
  Go to your [Modudraft dashboard](https://app.modudraft.com/dashboard) → **Settings → API Keys** → **Create new key**.
22
22
 
23
- Copy the key you'll only see it once.
23
+ Copy the key - you'll only see it once.
24
24
 
25
25
  ### 2. Add to your MCP config
26
26
 
@@ -151,7 +151,7 @@ Copy the key — you'll only see it once.
151
151
  |---|---|
152
152
  | `scan_project` | Scan a directory and list all importable files (docker-compose, K8s, Terraform, SQL, Prisma, OpenAPI, etc.) |
153
153
  | `read_file` | Read any file from the filesystem |
154
- | `import_file` | Import a file into a diagram auto-detects format |
154
+ | `import_file` | Import a file into a diagram - auto-detects format |
155
155
 
156
156
  **Supported import formats:**
157
157
  - **Architecture:** `docker-compose.yml` → nodes + edges
@@ -179,7 +179,7 @@ Copy the key — you'll only see it once.
179
179
  ### Cross-diagram intelligence
180
180
  | Tool | Description |
181
181
  |---|---|
182
- | `find_shared_services` | Find nodes that appear in multiple diagrams useful for shared infrastructure audits |
182
+ | `find_shared_services` | Find nodes that appear in multiple diagrams - useful for shared infrastructure audits |
183
183
  | `suggest_connections` | Detect likely missing edges based on archetype pairs |
184
184
  | `suggest_architecture` | Generate a suggested node/edge structure from a text description |
185
185
  | `clone_diagram` | Deep-copy a diagram as a starting template |
@@ -194,7 +194,7 @@ Copy the key — you'll only see it once.
194
194
  ### Org context
195
195
  | Tool | Description |
196
196
  |---|---|
197
- | `get_org_context` | Get cached org context existing tools, protocols, naming patterns |
197
+ | `get_org_context` | Get cached org context - existing tools, protocols, naming patterns |
198
198
  | `refresh_org_context` | Force a refresh of the org context cache |
199
199
 
200
200
  ---
@@ -211,9 +211,9 @@ Copy the key — you'll only see it once.
211
211
 
212
212
  > "Generate Terraform stubs for everything in the cloud tab and save to ./infra/main.tf."
213
213
 
214
- > "Validate diagram X are there any issues with the schema or missing connections?"
214
+ > "Validate diagram X - are there any issues with the schema or missing connections?"
215
215
 
216
- > "Compare diagram A and diagram B what changed between the two designs?"
216
+ > "Compare diagram A and diagram B - what changed between the two designs?"
217
217
 
218
218
  > "What services appear in more than one of our diagrams?"
219
219
 
@@ -221,7 +221,7 @@ Copy the key — you'll only see it once.
221
221
 
222
222
  > "Create a diagram of a typical e-commerce backend with a React frontend, API gateway, user service, product service, order service, PostgreSQL databases, Redis cache, and Kafka queue. Connect them and layout the diagram."
223
223
 
224
- > "Add the DB schema for the order service orders, order_items, and payments tables."
224
+ > "Add the DB schema for the order service - orders, order_items, and payments tables."
225
225
 
226
226
  > "Auto-generate a sequence diagram from the architecture."
227
227
 
@@ -231,7 +231,7 @@ Copy the key — you'll only see it once.
231
231
 
232
232
  ## How it works
233
233
 
234
- Each tool call requires a `diagram_id`. The server reads the current diagram from the Modudraft API, applies the change in memory, and writes it back with a 150ms debounce batch so rapid sequential edits (add 10 nodes, add edges) result in a single API round trip. Changes appear instantly in the Modudraft web app.
234
+ Each tool call requires a `diagram_id`. The server reads the current diagram from the Modudraft API, applies the change in memory, and writes it back - with a 150ms debounce batch so rapid sequential edits (add 10 nodes, add edges) result in a single API round trip. Changes appear instantly in the Modudraft web app.
235
235
 
236
236
  The `get_diagram` response includes a `hints` array listing nodes with empty metadata fields so your AI assistant knows what context to ask you for.
237
237
 
@@ -242,7 +242,7 @@ The `get_diagram` response includes a `hints` array listing nodes with empty met
242
242
  - API keys are hashed (SHA-256) server-side and never stored in plain text
243
243
  - Keys can be revoked at any time from the dashboard
244
244
  - All requests use HTTPS
245
- - `.env` file imports redact all secrets only topology metadata (host, port, database name, region) is ever extracted; passwords, tokens, and API keys are always replaced with `[REDACTED]`
245
+ - `.env` file imports redact all secrets - only topology metadata (host, port, database name, region) is ever extracted; passwords, tokens, and API keys are always replaced with `[REDACTED]`
246
246
 
247
247
  ---
248
248