@superdoc-dev/mcp 0.2.0-next.4 → 0.2.0-next.6

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 +23 -59
  2. package/dist/index.js +235371 -155711
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -67,7 +67,12 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
67
67
 
68
68
  ## Tools
69
69
 
70
- 23 tools in eight groups. All tools take a `session_id` from `superdoc_open`.
70
+ The MCP server exposes 12 tools total:
71
+
72
+ - 3 lifecycle tools: `superdoc_open`, `superdoc_save`, `superdoc_close`
73
+ - 9 grouped intent tools generated from the SDK catalog
74
+
75
+ All tools except `superdoc_open` take a `session_id` from `superdoc_open`.
71
76
 
72
77
  ### Lifecycle
73
78
 
@@ -77,78 +82,37 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
77
82
  | `superdoc_save` | Save the document to disk (original path or custom `out` path) |
78
83
  | `superdoc_close` | Close the session and release memory |
79
84
 
80
- ### Query
81
-
82
- | Tool | Description |
83
- | --- | --- |
84
- | `superdoc_find` | Search by text pattern, node type, or both. Returns addresses for mutations |
85
- | `superdoc_get_node` | Get details about a specific node |
86
- | `superdoc_info` | Document metadata and structure |
87
- | `superdoc_get_text` | Full plain text of the document |
88
-
89
- ### Mutation
90
-
91
- | Tool | Description |
92
- | --- | --- |
93
- | `superdoc_insert` | Insert text at a position. Set `suggest=true` for tracked changes |
94
- | `superdoc_replace` | Replace content at a range. Set `suggest=true` for tracked changes |
95
- | `superdoc_delete` | Delete content at a range. Set `suggest=true` for tracked changes |
96
-
97
- ### Format
98
-
99
- | Tool | Description |
100
- | --- | --- |
101
- | `superdoc_format` | Toggle formatting (`bold`, `italic`, `underline`, `strikethrough`). Set `suggest=true` for tracked changes |
102
-
103
- ### Create
85
+ ### Intent tools
104
86
 
105
- | Tool | Description |
106
- | --- | --- |
107
- | `superdoc_create` | Create a block element (`paragraph`, `heading`). Set `suggest=true` for tracked changes |
108
-
109
- ### Track changes
110
-
111
- | Tool | Description |
112
- | --- | --- |
113
- | `superdoc_list_changes` | List all tracked changes with type, author, and excerpt |
114
- | `superdoc_accept_change` | Accept a single tracked change |
115
- | `superdoc_reject_change` | Reject a single tracked change |
116
- | `superdoc_accept_all_changes` | Accept all tracked changes |
117
- | `superdoc_reject_all_changes` | Reject all tracked changes |
118
-
119
- ### Comments
120
-
121
- | Tool | Description |
122
- | --- | --- |
123
- | `superdoc_add_comment` | Add a comment anchored to a text range |
124
- | `superdoc_list_comments` | List all comments with author, status, and anchored text |
125
- | `superdoc_reply_comment` | Reply to an existing comment thread |
126
- | `superdoc_resolve_comment` | Mark a comment as resolved |
127
-
128
- ### Lists
129
-
130
- | Tool | Description |
131
- | --- | --- |
132
- | `superdoc_insert_list` | Insert a list item before or after an existing one |
133
- | `superdoc_list_set_type` | Change a list between ordered and bullet |
87
+ | Tool | Actions | Description |
88
+ | --- | --- | --- |
89
+ | `superdoc_get_content` | `text`, `markdown`, `html`, `info` | Read document content in different formats |
90
+ | `superdoc_search` | `match` | Find text or nodes and return handles or addresses for later edits |
91
+ | `superdoc_edit` | `insert`, `replace`, `delete`, `undo`, `redo` | Perform text edits and history actions |
92
+ | `superdoc_format` | `inline`, `set_style`, `set_alignment`, `set_indentation`, `set_spacing` | Apply inline or paragraph formatting |
93
+ | `superdoc_create` | `paragraph`, `heading` | Create structural block elements |
94
+ | `superdoc_list` | `insert`, `create`, `detach`, `indent`, `outdent`, `set_level`, `set_type` | Create and manipulate lists |
95
+ | `superdoc_comment` | `create`, `update`, `delete`, `get`, `list` | Manage comment threads |
96
+ | `superdoc_track_changes` | `list`, `decide` | Review and resolve tracked changes |
97
+ | `superdoc_mutations` | `preview`, `apply` | Execute multi-step atomic edits as a batch |
134
98
 
135
99
  ## Workflow
136
100
 
137
101
  Every interaction follows the same pattern:
138
102
 
139
103
  ```
140
- open → read/edit → save → close
104
+ open → read/search → edit → save → close
141
105
  ```
142
106
 
143
107
  1. `superdoc_open` loads a document and returns a `session_id`
144
- 2. `superdoc_find` locates content and returns addresses
145
- 3. Edit tools use those addresses to modify content
108
+ 2. `superdoc_get_content` reads the current document and `superdoc_search` finds stable handles or addresses
109
+ 3. Intent tools use `session_id` plus `action` to modify content
146
110
  4. `superdoc_save` writes changes to disk
147
111
  5. `superdoc_close` releases the session
148
112
 
149
- ### Suggesting mode
113
+ ### Tracked changes
150
114
 
151
- Set `suggest=true` on any mutation, format, or create tool to make edits appear as tracked changes (suggestions) instead of direct edits. Use `superdoc_list_changes` to review them, and `superdoc_accept_change` / `superdoc_reject_change` to resolve them.
115
+ Actions that support tracked edits use the underlying Document API's `changeMode: "tracked"` option. Review or resolve tracked edits with `superdoc_track_changes`.
152
116
 
153
117
  ## Development
154
118