## Tools overview

| Tool | Purpose | Mutates |
|------|---------|---------|
| superdoc_get_content | Read document content (blocks, text, markdown, html, info) | No |
| superdoc_search | Find text or nodes, get ref handles for targeting | No |
| superdoc_edit | Insert, replace, delete text, undo/redo | Yes |
| superdoc_create | Create paragraphs, headings, or tables | Yes |
| superdoc_format | Apply inline and paragraph formatting, set named styles | Yes |
| superdoc_list | Create and manipulate bullet/numbered lists | Yes |
| superdoc_table | Create / modify tables: structure, cell text, styling | Yes |
| superdoc_comment | Create, update, delete, and list comment threads | Yes |
| superdoc_track_changes | List, accept, or reject tracked changes | Yes |
| superdoc_mutations | Execute multi-step atomic edits in a single batch | Yes |

## How targeting works

Every editing tool needs a **target** telling the API *where* to apply the change. There are three ways to get one:

- **From blocks data**: Each block has a `ref` (pass directly to superdoc_edit or superdoc_format), a `nodeId` (for building `at` positions with superdoc_create or `where: {by: "block", ...}` in superdoc_mutations), and optional full `text` when you call `superdoc_get_content({action: "blocks", includeText: true})`.
- **From superdoc_search**: Returns `handle.ref` covering the matched text. Use search when you need to find text patterns, not when you already know which block to target.
- **From superdoc_create**: Returns `nodeId` and `ref`. The ref is valid for one immediate format call. For subsequent operations, re-fetch blocks to get fresh refs.

**Refs expire after any mutation** between separate tool calls. Within a superdoc_mutations batch, selectors resolve automatically — no manual re-searching between steps.

**Critical targeting rule:** when rewriting an entire paragraph, clause, or other known block, first read `superdoc_get_content({action: "blocks", includeText: true})`, identify the block's `nodeId`, then use `where: {by: "block", nodeType, nodeId}` in `superdoc_mutations`. Do NOT use a shortened text selector to rewrite a whole clause.

## Common workflows

### Replace a word everywhere

```
superdoc_search({select: {type: "text", pattern: "old word"}, require: "all"})
superdoc_edit({action: "replace", ref: "<handle.ref>", text: "new word"})
```

Use `require: "all"` with a single edit, not multiple steps targeting the same pattern.

### Rewrite a full paragraph

```
superdoc_get_content({action: "blocks", includeText: true})
// Find the paragraph/clause by its full text, then use its nodeId
superdoc_mutations({
  action: "apply", atomic: true,
  steps: [
    {
      id: "r1",
      op: "text.rewrite",
      where: {by: "block", nodeType: "paragraph", nodeId: "<nodeId>"},
      args: {replacement: {text: "Entirely new paragraph text."}}
    }
  ]
})
```

Use `includeText:true` so you can identify the right block from one read call. A block ref from superdoc_get_content covers the entire block text, but for multi-step rewrites and contract redlines, prefer `where: {by: "block", ...}` in `superdoc_mutations` because it is stable and avoids brittle text matching. A search ref covers only the matched substring. Do NOT use a shortened search/text selector to replace an entire known block.

### Redline a contract clause

```
superdoc_get_content({action: "blocks", includeText: true})
// Identify the clause block using blocks[i].text and blocks[i].nodeId
superdoc_mutations({
  action: "apply", atomic: true, changeMode: "tracked",
  steps: [
    {
      id: "clause1",
      op: "text.rewrite",
      where: {by: "block", nodeType: "listItem", nodeId: "<nodeId>"},
      args: {replacement: {text: "Customer agrees to ..."}}
    }
  ]
})
```

If you only know a short anchor, use `superdoc_search` to locate the clause, then convert that result to the containing block `nodeId` before calling `text.rewrite`. Use `by:"select"` for discovery, not for whole-clause replacement.

### Add a new paragraph after a heading

```
superdoc_search({select: {type: "text", pattern: "Introduction"}, require: "first"})
// Get blockId from result.items[0].blocks[0].blockId
superdoc_create({action: "paragraph", text: "New content here.", at: {kind: "after", target: {kind: "block", nodeType: "heading", nodeId: "<blockId>"}}})
// Re-fetch blocks to get a fresh ref for the new paragraph
superdoc_get_content({action: "blocks", offset: 0, limit: 5})
// Find the new paragraph in the response, use its ref and nodeId
// Read formatting from BODY TEXT paragraphs (non-title, alignment "justify" or "left"), not from headings
superdoc_format({action: "inline", ref: "<new block ref>", inline: {fontFamily: "<from body blocks>", fontSize: <from body blocks>, color: "<from body blocks>", bold: false}})
superdoc_format({action: "set_alignment", target: {kind: "block", nodeType: "paragraph", nodeId: "<create.nodeId>"}, alignment: "<from body blocks>"})
```

### Create multiple paragraphs in sequence

Create all paragraphs first (chaining nodeIds), then re-fetch blocks once and format them all:

```
// Step 1: Create all paragraphs, chaining with nodeId
superdoc_create({action: "paragraph", text: "First item.", at: {kind: "documentEnd"}})
// Use nodeId from response for next create
superdoc_create({action: "paragraph", text: "Second item.", at: {kind: "after", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId1>"}}})
superdoc_create({action: "paragraph", text: "Third item.", at: {kind: "after", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId2>"}}})

// Step 2: Re-fetch blocks to get fresh refs for all new paragraphs
superdoc_get_content({action: "blocks", offset: 0, limit: 10})

// Step 3: Format each paragraph using fresh refs from blocks
// Read formatting from BODY TEXT paragraphs (alignment "justify" or "left", not titles)
superdoc_format({action: "inline", ref: "<fresh ref1>", inline: {fontFamily: "<body>", fontSize: <body>, color: "<body>", bold: false}})
superdoc_format({action: "set_alignment", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId1>"}, alignment: "<body alignment>"})
// Repeat for each paragraph...
```

### Write content into a blank document

Do not use `superdoc_search` to find empty initial paragraphs — search matches text, and blank blocks have none. Use `superdoc_get_content` for blank-block discovery.

```
// Step 1: First create — omit positional `at` targeting on a blank document
superdoc_create({action: "paragraph", text: "First paragraph."})

// Step 2: Fetch blocks to get nodeIds for subsequent relative inserts
superdoc_get_content({action: "blocks"})

// Step 3: Chain further creates using nodeIds from blocks
superdoc_create({action: "paragraph", text: "Second paragraph.", at: {kind: "after", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId1>"}}})
```

### Bold or format existing text

```
superdoc_search({select: {type: "text", pattern: "important phrase"}, require: "first"})
superdoc_format({action: "inline", ref: "<handle.ref>", inline: {bold: true}})
```

### Set paragraph alignment, spacing, or page breaks

Paragraph-level actions require a **block target with nodeId**, not a ref:

```
superdoc_format({action: "set_alignment", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId>"}, alignment: "center"})
superdoc_format({action: "set_flow_options", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId>"}, pageBreakBefore: true})
superdoc_format({action: "set_spacing", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId>"}, lineSpacing: {rule: "auto", value: 1.5}})
```

### Create a bullet or numbered list

1. Create all paragraphs at the SAME location, chaining with previous nodeId:
```
superdoc_create({action: "paragraph", text: "Item one", at: {kind: "documentEnd"}})
superdoc_create({action: "paragraph", text: "Item two", at: {kind: "after", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId1>"}}})
superdoc_create({action: "paragraph", text: "Item three", at: {kind: "after", target: {kind: "block", nodeType: "paragraph", nodeId: "<nodeId2>"}}})
```

2. Convert the consecutive paragraphs to a list in one call:
```
superdoc_list({action: "create", mode: "fromParagraphs", preset: "disc", target: {from: {kind: "block", nodeType: "paragraph", nodeId: "<first>"}, to: {kind: "block", nodeType: "paragraph", nodeId: "<last>"}}})
```

Use preset "disc" for bullets, "decimal" for numbered. WARNING: the range converts ALL paragraphs between from and to. Make sure no other content exists between them.

3. To change a bullet list to numbered: `superdoc_list({action: "set_type", target: {kind: "block", nodeType: "listItem", nodeId: "<anyItemId>"}, kind: "ordered"})`

### Add items to an existing list

To add a new item adjacent to an existing list item, use `superdoc_list({action: "insert"})`, NOT `superdoc_create({action: "paragraph"})` — the latter creates a standalone paragraph that is not part of the list:

```
superdoc_get_content({action: "blocks"})  // find the listItem nodeId you want to insert next to
superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, position: "after", text: "New item text"})
```

**Level inheritance.** The new item inherits the target's nesting level. Insert after a level-0 item → new item is level 0. Insert after a level-2 item → new item is level 2. To change the level, chain `indent` / `outdent` / `set_level` on the nodeId returned in the insert response.

**Use the nodeId from the response directly.** `superdoc_list({action: "insert"})` returns `{item: {nodeId: "<id>"}}` — that id is ready for subsequent `indent`, `outdent`, `set_level`, or text edits. You do NOT need to re-fetch blocks between the insert and the follow-up operation.

### Add a sub-point under an existing item

Insert a peer, then indent it one level:

```
// 1. Insert a peer item after the parent — new item is at the parent's level
const resp = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<parentItemId>"}, position: "after", text: "Sub-point"})

// 2. Indent using the nodeId from resp.item.nodeId
superdoc_list({action: "indent", target: {kind: "block", nodeType: "listItem", nodeId: "<resp.item.nodeId>"}})
```

### Build a nested list with mixed levels

`lists.create` produces a flat list. Add nesting by chaining `insert` + `indent` / `set_level`, using the nodeId returned by each insert to target the next step:

```
// Starting point: a list item at level 0 ("Parent" with nodeId <parent>)

// Sibling at level 0
const r1 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<parent>"}, position: "after", text: "Sibling"})

// Child at level 1 (insert after r1, then indent)
const r2 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<r1.item.nodeId>"}, position: "after", text: "Child"})
superdoc_list({action: "indent", target: {kind: "block", nodeType: "listItem", nodeId: "<r2.item.nodeId>"}})

// Grandchild at level 3 (insert after r2, then jump to level 3 directly)
const r3 = superdoc_list({action: "insert", target: {kind: "block", nodeType: "listItem", nodeId: "<r2.item.nodeId>"}, position: "after", text: "Deep"})
superdoc_list({action: "set_level", target: {kind: "block", nodeType: "listItem", nodeId: "<r3.item.nodeId>"}, level: 3})
```

`indent` bumps the level by one (bounded 0–8). `set_level` jumps directly to any level 0–8. Markers update automatically based on the list's definition for each level (e.g. `1.` / `a.` / `i.` for an ordered list).

### Merge two adjacent lists into one

Use `merge` — it handles the common case where two ordered or bulleted lists sit next to each other and should become one continuous list. Absorbed items adopt the absorbing sequence's definition, and any empty paragraphs between the two lists are removed so numbering flows continuously.

```
superdoc_get_content({action: "blocks"})  // find a listItem in either sequence
// To merge with the previous sequence:
superdoc_list({action: "merge", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, direction: "withPrevious"})
// Or with the next sequence:
superdoc_list({action: "merge", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, direction: "withNext"})
```

### Split a list into two

Use `split` to break one list into two independent lists at a specific item. The target and everything after become a new sequence that restarts numbering at 1:

```
superdoc_list({action: "split", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}})
```

Pass `restartNumbering: false` if you want the new half to keep counting from where the original left off.

### Restart numbering at a specific item

For ordered lists. To make item N restart from a chosen number (commonly 1):

```
superdoc_list({action: "set_value", target: {kind: "block", nodeType: "listItem", nodeId: "<itemId>"}, value: 1})
```

Pass `value: null` to clear a previously-set restart override and let the item resume natural numbering.

### Continue numbering across a break

For ordered lists. When two sibling sequences should be numbered as one (e.g. numbering jumps back to 1 and you want it to continue from where the previous list left off), target the FIRST item of the second sequence:

```
superdoc_list({action: "continue_previous", target: {kind: "block", nodeType: "listItem", nodeId: "<firstItemOfSecondList>"}})
```

Fails with `NO_COMPATIBLE_PREVIOUS` or `INCOMPATIBLE_DEFINITIONS` if no prior sequence shares the same abstract definition. In that case, use `merge` instead — it handles mismatched definitions, removes empty gap paragraphs, and produces one continuous list.

### Insert content into a document (new or existing)

Markdown insert creates block structure but uses default formatting. You MUST follow up with formatting so inserted content looks like it belongs in the document.

**Step 1: Understand the document context** from the get_content blocks response. Before inserting anything, analyze:
- What kind of document is this? (contract, letter, certificate, report, etc.)
- How are titles/headings styled? (centered? left? bold? underlined? what fontSize?)
- Are titles UPPERCASE? (e.g., "EMPLOYMENT AGREEMENT", "RECITALS" → your heading must also be UPPERCASE)
- How is body text styled? (fontFamily, fontSize, alignment, color)
- What formatting conventions does the document follow?

Your inserted content must be indistinguishable from the existing content. If titles are ALL CAPS centered 10pt, your heading text must also be ALL CAPS centered 10pt. If body text is justified 12pt, your paragraphs must be justified 12pt.

**Step 2: Insert content with markdown:**

```
superdoc_edit({action: "insert", type: "markdown",
  target: {kind: "block", nodeType: "paragraph", nodeId: "<first-block-nodeId>"},
  placement: "before",
  value: "# Executive Summary\n\nThis agreement sets forth the principal terms..."})
```

**Step 3: Format ALL inserted blocks in ONE superdoc_mutations call.** Each format.apply step accepts `inline`, `alignment`, and `scope: "block"`.

Use `scope: "block"` so formatting covers the entire paragraph (not just the matched text). The text pattern only needs to identify which block. Copy the exact property values from the existing blocks in the get_content response. Do NOT invent values.

Example: document blocks show fontFamily, fontSize: 10, color, titles centered:
```
superdoc_mutations({action: "apply", atomic: true, steps: [
  {id: "f1", op: "format.apply", where: {by: "select", select: {type: "text", pattern: "Executive Summary"}, require: "first"}, args: {inline: {fontFamily: "Times New Roman, serif", fontSize: 10, color: "#000000"}, alignment: "center", scope: "block"}},
  {id: "f2", op: "format.apply", where: {by: "select", select: {type: "text", pattern: "This agreement sets forth"}, require: "first"}, args: {inline: {fontFamily: "Times New Roman, serif", fontSize: 10, color: "#000000"}, scope: "block"}}
]})
```

Total: 3 calls (read + insert + format-all-in-one-batch). Never more.

### Batch multiple text edits atomically

Use superdoc_mutations for 2+ text changes, format changes, or a combination:

```
superdoc_get_content({action: "blocks", includeText: true})
superdoc_mutations({
  action: "apply", atomic: true, changeMode: "direct",
  steps: [
    {id: "s1", op: "text.rewrite", where: {by: "block", nodeType: "paragraph", nodeId: "<paragraphNodeId>"}, args: {replacement: {text: "Updated full paragraph text."}}},
    {id: "s2", op: "text.delete", where: {by: "select", select: {type: "text", pattern: " (deprecated)"}, require: "all"}, args: {}},
    {id: "s3", op: "text.insert", where: {by: "select", select: {type: "text", pattern: "Section Title"}, require: "first"}, args: {position: "after", content: {text: " (Updated)"}}}
  ]
})
```

Use `by:"block"` for whole-paragraph / whole-clause rewrites. Use `by:"select"` only for substring edits, discovery, or insertion relative to a sentence fragment.

Selectors resolve at compile time (before execution). This means format.apply steps CANNOT target content created by create steps in the same batch — the new content does not exist yet when selectors compile. Split creates and formatting into separate batches.

Never create two steps targeting overlapping text in the same block. Combine them into a single text.rewrite instead.

### Tables: cross-tool workflows

Tool-local rules (which action to pick, locator shapes, color formats) live in the `superdoc_table` description itself. The rules below cover workflows that **cross tools** — that's the part the model gets wrong without explicit guidance.

**1. After `set_cell_text`, format the new cell to match its siblings.**
`set_cell_text` writes plain text with no formatting. To match the rest of the table:

```
// Read a sibling cell's text style first (or any body paragraph if the table is fresh):
superdoc_get_content({action: "blocks", includeText: true})

// Apply matching inline style to the new cell's paragraph:
superdoc_format({action: "inline", ref: "<new-cell-paragraph-ref>",
  inline: {fontFamily, fontSize, color, bold: false}})
```

If sibling cells show a bold-prefix pattern like `"Label: value"`, replicate it on the new cell using `superdoc_search` + `superdoc_format` (or one `superdoc_mutations` batch with `format.apply` steps using `where:{by:"select", ...}`).

**2. "Style the whole table" crosses `superdoc_table` and `superdoc_format`.**
Borders / shading / cnf flags / spacing live on `superdoc_table`. **Cell-text alignment and font color/weight live on `superdoc_format`** (they're paragraph- and run-level). A complete table-styling pass calls both:

```
// Table-level (superdoc_table):
set_borders applyTo:"all" with explicit color
set_shading on the header cells with the accent color
set_style_options { headerRow: true }

// Cell-text level (superdoc_format, per cell paragraph):
set_alignment on header (center) and body (left or right)
inline { color, bold } on header cells

// Batch many cell-level format calls via superdoc_mutations format.apply.
```

Discover the document's palette by reading `superdoc_get_content({action: "blocks"})` and reusing colors from existing tables/headings. When none are obvious, default to `1F3864` (corporate blue) or `444444` (dark grey) for accents and `F2F2F2` / `E7E6E6` for banding. Never use `auto` when a concrete color is implied.

**3. After a structural change to a styled table, re-apply the existing styling.**
Triggers: `insert_row`, `insert_column`, `delete_row`, `delete_column`, `merge_cells`, `unmerge_cells` — but NOT `set_cell_text` or `set_cell` (those don't disturb borders/shading). Read the current borders/shading/cnf flags via `superdoc_get_content({action: "blocks"})` before the change, then re-run the same `set_borders` / `set_shading` / `set_style_options` calls with the SAME values after. Goal is consistency, not redesign. Skip on a freshly created table — a new table starts un-styled.

**4. Convert a list to a table.**
Three steps:
1. `superdoc_create({action: "table", rows: N, columns: M, at: ...})`
2. Populate cells with `superdoc_table({action: "set_cell_text", ...})` — one call per cell.
3. **Delete the source list** with one `superdoc_list` call:

```
superdoc_list({action: "delete", target: {kind: "block", nodeType: "listItem", nodeId: "<any-item-id>"}})
```

Wrong paths (all leave bullets/empty paragraphs behind): `text.delete`, `superdoc_edit` action `delete` on text refs, `lists.detach`, `lists.convertToText`. Only `superdoc_list` action `delete` removes the whole list.

### Add a comment on specific text

```
superdoc_search({select: {type: "text", pattern: "target phrase"}, require: "first"})
superdoc_comment({
  action: "create",
  text: "Please review this section.",
  target: {kind: "text", blockId: "<items[0].blocks[0].blockId>", range: {start: <items[0].blocks[0].range.start>, end: <items[0].blocks[0].range.end>}}
})
```

Only pass `action`, `text`, and `target` when creating a new top-level comment. For threaded replies, add `parentId`.

### Accept or reject tracked changes

```
superdoc_track_changes({action: "list"})
// Review changes, then accept or reject
superdoc_track_changes({action: "decide", decision: "accept", target: {id: "<changeId>"}})
// Or accept all at once
superdoc_track_changes({action: "decide", decision: "accept", target: {scope: "all"}})
```

### Match existing document formatting (CRITICAL)

When creating content "like" or "similar to" existing content:

1. Read blocks to get exact formatting properties of the reference content
2. Use the same nodeType. Title blocks are often bold+underline paragraphs, not heading nodes. Check the blocks data.
3. Copy ALL formatting exactly: bold, underline, fontSize, fontFamily, color, alignment

### Choosing formatting values (CRITICAL)

When formatting newly created content, use the right source:

- **Body text** (paragraphs, lorem ipsum, regular content): Read fontFamily, fontSize, color from non-empty, non-title paragraphs with alignment "justify" or "left". Always set `bold: false` and `underline: false` for body text. Many DOCX documents report `underline: true` on all blocks due to style inheritance; this is a style artifact, not intentional formatting. Body paragraphs should NOT be underlined unless the user explicitly asks for it.
- **Headings/titles**: Read from existing heading or title blocks (centered, bold, possibly underline). Scale fontSize up from body text.
- **Signature/form fields**: Use justify or left alignment
- When the user says "heading", use `action: "heading"` with a level, even if the document uses styled paragraphs as titles.

## Constraints

- **Format calls must be sequential.** Each format call bumps the document revision and invalidates all outstanding refs. Do NOT issue multiple superdoc_format calls in parallel. Format one block, then re-fetch if needed for the next block.
- **set_alignment target must be `{kind: "block", nodeType, nodeId}`.** NEVER use `{kind: "block", start: {kind: "nodeEdge", ...}}` or any selection-like structure. Only the flat block target with nodeType and nodeId is accepted.
- **Always format ALL created items.** If formatting fails partway through a batch, re-fetch blocks and continue formatting the remaining items. Do not stop after a partial failure.
- **Search patterns are plain text.** Do not include `#`, `**`, or formatting markers.
- **`select.type` must be "text" or "node".** To find headings: `{type: "node", nodeType: "heading"}`, NOT `{type: "heading"}`.
- **`within` scopes to a single block**, not a section. To find text in a section, search the full document.
- **Table cells are separate blocks.** Search for individual cell values, not patterns spanning multiple cells.
- **Do NOT combine `limit`/`offset` with `require: "first"` or `require: "exactlyOne"`.** Use `require: "any"` with `limit` for paginated results.
- **Do NOT hardcode formatting values.** Always read from blocks data and replicate.
- **Do NOT copy heading/title formatting onto body paragraphs.** Read from body text blocks (alignment "justify" or "left"), not title blocks.
- **Pass structured objects, not JSON-encoded strings.** Fields like `at`, `target`, and `inline` expect objects, not serialized JSON strings.
- **Only pass `dryRun` when the action's schema explicitly lists it.** Do not assume every action accepts it. Prefer a real call over a preview for destructive actions unless dryRun is documented for that action.
- **If blocks still report `underline: true` after you explicitly removed it, treat it as a style inheritance artifact.** Do not retry formatting to fix it.
- **On "Unknown field" errors, drop the unrecognized field and retry.** Use the narrowest working call shape rather than guessing alternative field names.
- **Table styling crosses two tools.** Borders / shading / cnf flags / spacing are on `superdoc_table`; cell-text alignment and font color/weight are on `superdoc_format` (paragraph- and run-level). A "style the whole table" pass calls both. See the Tables: cross-tool workflows section for the full recipe.
- **To delete a list, use `superdoc_list` action `delete`.** Pass any list-item nodeId. Never use `text.delete`, `superdoc_edit` action `delete`, `lists.detach`, or `lists.convertToText` for "remove the list" — they leave empty list-item paragraphs behind.
