Mintlify

Read the full MDX content of a single page on the current branch. Reflects in-session edits made via edit_page/write_page, not just the published version. `path` is the page href (e.g. "/quickstart" or "guides/setup"), with or without a leading slash or trailing .mdx. Returns `{ content, filePath }` on success, or `{ error: "read_failed", reason }` on failure (`reason` carries the human-readable diagnostic such as "No valid pageId found for page" or a hocuspocus connection error).

Find lines matching a substring or regex across every page on the current branch. Returns { matches, truncated } where each match is { path, lineNumber, line }, sorted by path. Reflects in-session edits: pages edited in this session are scanned even before indexing catches up. `query` is treated as a literal fixed string by default; pass `regex: true` for regex syntax. `caseSensitive` defaults to false. `limit` caps results (default 100, max 500). The response is bounded to 30KB — `truncated: true` indicates results were dropped and you should refine the query.

List navigation nodes with optional filters over the current branch nav tree. `parentId: null` returns root-level nodes; a string returns direct children of that node; omit for no filter. `recursive: true` extends the parent filter to all descendants of `parentId` — pair with `parentId: null` (or omit) to dump the entire tree in a single call. `type` accepts a single type or array (e.g. "group"). `language`, `version`, and `tab` are scope filters: a node passes only if its ancestor chain (including itself) contains a matching division node — filtering by a value not present in the tree returns empty. `limit` defaults to 500 (max 500). `cursor` is an opaque pagination token returned as `nextCursor`, stable across inserts. Returns { nodes, nextCursor } where nextCursor is null when exhausted.

Get current session state including branch name, edited files, and nav diff

Returns the list of changes between current session and main.

String-replace edit on a page Y.Doc body. Use this for MDX content edits only — do NOT use it to change frontmatter fields (`title`, `sidebarTitle`, `description`, `icon`, `tag`, `canonical`, `og:*`, `keywords`, `noindex`, `hidden`, etc.); those round-trip through structured node metadata and must be set via `update_node` with `data.type='page'`. For the site-level `description` in `docs.json`, use `update_config`. Edits are broadcast live to connected collaborators: plain inline-text edits inside a single paragraph stream character-by-character (typing effect); structural edits apply atomically. The returned `mode` reports which path ran (`inline-stream` or `rebuild`).

Full overwrite of a page Y.Doc content

Insert a node into the navigation tree under `parentId` (null = root). `order` is clamped into siblings and defaults to append. `data` is discriminated by `type`: `page` seeds a Y.Doc from `{ path, content }` (MDX is validated), while `group`, `tab`, `anchor`, `version`, `language`, and `product` take their own name-shaped fields. Parent/child compatibility is enforced against an allowed-children table (e.g. groups cannot contain tabs; pages have no children).

Update a navigation node's properties in place by nodeId — no repositioning. `data` is a discriminated union on `type` carrying partial, type-specific fields that are merged into existing `node.data`. For `type:'page'`, this is the correct tool for editing the page's frontmatter (`title`, `sidebarTitle`, `description`, `icon`, `tag`, `canonical`, `og:title`, `og:url`, `keywords`, `noindex`, `hidden`, `deprecated`, etc.) — the merged fields are serialized back into the MDX `---` block on save; do not use `edit_page` for these. `data.type` must match the stored node type. Immutable fields (`href`/`pageId` on pages, internal flags) are rejected — use `move_node` to rename a page path. Page updates emit an `update` pending action with source `metadata`; structural node updates emit an `update-navigation` action. Emits `editor_nav_updated`. Examples: set a page's frontmatter description (`{type:'page', description:'…'}`), rename a group (`{type:'group', group:'New Name'}`), change a tab icon, set a version as default.

Remove a node and all its descendants from the navigation tree by `nodeId`. For page descendants in the removed set, the hocuspocus room, document S3 blob, and baseline (Redis + S3) are cleaned up. `redirect` is only valid when the target itself is a page; when set, appends `{source, destination, permanent: true}` to `docsConfig.redirects`. Returns `{ deletedNodeIds }`.

Reposition a node in the navigation tree by nodeId. `parentId: null` moves to root; omit to keep the current parent. `order` is 0-based among the new siblings; omit to append. At least one of `parentId` or `order` is required. Parent/child compatibility is enforced against the allowed-children table. Cross-boundary moves (across version, tab, language, or product ancestors) are allowed; the response flags them via `crossedBoundary`.

Update any top-level `docs.json` field except `navigation` (use the navigation tree tools for that). This is the ONLY way to change the site-level `description` (the SEO/social description for the whole docs site) — do not use `edit_page` (which targets page body) or `update_node` (which targets a single page's frontmatter description). `op` selects the operation: `set` ({ docsConfig }) shallow-merges any partial `docs.json` (e.g. `{ theme, name, description, colors, logo, favicon, api, appearance, background, navbar, footer, fonts, search, contextual, banner, interaction, errors, seo, styling, integrations, metadata, ... }` — see https://www.mintlify.com/docs.json); `add_redirect` ({ redirect: { source, destination, permanent? } }) appends to `redirects` (rejects on duplicate source); `remove_redirect` ({ source }) removes by source (rejects if missing). `set` rejects `navigation` and `$schema` keys. Set a top-level key to `null` in `docsConfig` to unset (remove) it entirely. The merged config is validated against the @mintlify/validation schema — any violation rejects the call with no partial writes. Returns `{ diff }` of only the changed fields: array-valued fields (e.g. `redirects`, `navbar.links`) report `{ added, removed }`, nested objects recurse under `{ changed }`, and scalar leaves report `{ before, after }`.