@usejunior/docx-mcp 0.0.1 → 0.1.1

package/dist/tool_catalog.d.ts

@@ -0,0 +1,439 @@
+import { z } from 'zod';
+export declare const SAFE_DOCX_TOOL_CATALOG: readonly [{
+    readonly name: "read_file";
+    readonly description: "Read document content with paragraph IDs. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        offset: z.ZodOptional<z.ZodNumber>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        node_ids: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        format: z.ZodOptional<z.ZodEnum<{
+            toon: "toon";
+            json: "json";
+            simple: "simple";
+        }>>;
+        show_formatting: z.ZodOptional<z.ZodBoolean>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "grep";
+    readonly description: "Search paragraphs with regex. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        patterns: z.ZodArray<z.ZodString>;
+        case_sensitive: z.ZodOptional<z.ZodBoolean>;
+        whole_word: z.ZodOptional<z.ZodBoolean>;
+        max_results: z.ZodOptional<z.ZodNumber>;
+        context_chars: z.ZodOptional<z.ZodNumber>;
+        dedupe_by_paragraph: z.ZodOptional<z.ZodBoolean>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "init_plan";
+    readonly description: "Initialize revision-bound context metadata for coordinated multi-agent planning. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        plan_name: z.ZodOptional<z.ZodString>;
+        orchestrator_id: z.ZodOptional<z.ZodString>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "merge_plans";
+    readonly description: "Deterministically merge multiple sub-agent plans and detect hard conflicts before apply.";
+    readonly input: z.ZodObject<{
+        plans: z.ZodArray<z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>>;
+        fail_on_conflict: z.ZodOptional<z.ZodBoolean>;
+        require_shared_base_revision: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "apply_plan";
+    readonly description: "Validate and apply a batch of edit steps (replace_text, insert_paragraph) to a session document in one call. Validates all steps first; applies only if all pass. Accepts inline steps or a plan_file_path. Compatible with merge_plans output.";
+    readonly input: z.ZodObject<{
+        steps: z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>>>;
+        plan_file_path: z.ZodOptional<z.ZodString>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "replace_text";
+    readonly description: "Replace text in a paragraph by _bk_* id, preserving formatting. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        target_paragraph_id: z.ZodString;
+        old_string: z.ZodString;
+        new_string: z.ZodString;
+        instruction: z.ZodString;
+        normalize_first: z.ZodOptional<z.ZodBoolean>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "insert_paragraph";
+    readonly description: "Insert a paragraph before/after an anchor paragraph by _bk_* id. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        positional_anchor_node_id: z.ZodString;
+        new_string: z.ZodString;
+        instruction: z.ZodString;
+        position: z.ZodOptional<z.ZodEnum<{
+            BEFORE: "BEFORE";
+            AFTER: "AFTER";
+        }>>;
+        style_source_id: z.ZodOptional<z.ZodString>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "download";
+    readonly description: "Save clean and/or tracked changes output back to the user filesystem. Defaults to both clean and tracked outputs when no format override is provided. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        save_to_local_path: z.ZodString;
+        clean_bookmarks: z.ZodOptional<z.ZodBoolean>;
+        download_format: z.ZodOptional<z.ZodEnum<{
+            clean: "clean";
+            tracked: "tracked";
+            both: "both";
+        }>>;
+        allow_overwrite: z.ZodOptional<z.ZodBoolean>;
+        tracked_save_to_local_path: z.ZodOptional<z.ZodString>;
+        tracked_changes_author: z.ZodOptional<z.ZodString>;
+        tracked_changes_engine: z.ZodOptional<z.ZodEnum<{
+            auto: "auto";
+            atomizer: "atomizer";
+            diffmatch: "diffmatch";
+        }>>;
+        fail_on_rebuild_fallback: z.ZodOptional<z.ZodBoolean>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "format_layout";
+    readonly description: "Apply deterministic OOXML layout controls (paragraph spacing, table row height, cell padding). Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        strict: z.ZodOptional<z.ZodBoolean>;
+        paragraph_spacing: z.ZodOptional<z.ZodObject<{
+            paragraph_ids: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            before_twips: z.ZodOptional<z.ZodNumber>;
+            after_twips: z.ZodOptional<z.ZodNumber>;
+            line_twips: z.ZodOptional<z.ZodNumber>;
+            line_rule: z.ZodOptional<z.ZodEnum<{
+                auto: "auto";
+                exact: "exact";
+                atLeast: "atLeast";
+            }>>;
+        }, z.core.$strip>>;
+        row_height: z.ZodOptional<z.ZodObject<{
+            table_indexes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            row_indexes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            value_twips: z.ZodOptional<z.ZodNumber>;
+            rule: z.ZodOptional<z.ZodEnum<{
+                auto: "auto";
+                exact: "exact";
+                atLeast: "atLeast";
+            }>>;
+        }, z.core.$strip>>;
+        cell_padding: z.ZodOptional<z.ZodObject<{
+            table_indexes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            row_indexes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            cell_indexes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            top_dxa: z.ZodOptional<z.ZodNumber>;
+            bottom_dxa: z.ZodOptional<z.ZodNumber>;
+            left_dxa: z.ZodOptional<z.ZodNumber>;
+            right_dxa: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "accept_changes";
+    readonly description: "Accept all tracked changes in the document body, producing a clean document with no revision markup. Returns acceptance stats.";
+    readonly input: z.ZodObject<{
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "has_tracked_changes";
+    readonly description: "Check whether the document body contains tracked-change markers (insertions, deletions, moves, and property-change records). Read-only.";
+    readonly input: z.ZodObject<{
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "get_session_status";
+    readonly description: "Get session metadata. Accepts session_id or file_path.";
+    readonly input: z.ZodObject<{
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "clear_session";
+    readonly description: "Clear one session, all sessions for a file path, or all sessions with explicit confirmation.";
+    readonly input: z.ZodObject<{
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+        clear_all: z.ZodOptional<z.ZodBoolean>;
+        confirm: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "duplicate_document";
+    readonly description: "Duplicate a source .docx and auto-open a fresh editing session for the duplicate.";
+    readonly input: z.ZodObject<{
+        source_file_path: z.ZodString;
+        destination_file_path: z.ZodOptional<z.ZodString>;
+        overwrite: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "add_comment";
+    readonly description: "Add a comment or threaded reply to a document. Provide target_paragraph_id + anchor_text for root comments, or parent_comment_id for replies.";
+    readonly input: z.ZodObject<{
+        target_paragraph_id: z.ZodOptional<z.ZodString>;
+        anchor_text: z.ZodOptional<z.ZodString>;
+        parent_comment_id: z.ZodOptional<z.ZodNumber>;
+        author: z.ZodString;
+        text: z.ZodString;
+        initials: z.ZodOptional<z.ZodString>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "get_comments";
+    readonly description: "Get all comments from the document with IDs, authors, dates, text, and anchored paragraph IDs. Includes threaded replies. Read-only.";
+    readonly input: z.ZodObject<{
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "delete_comment";
+    readonly description: "Delete a comment and all its threaded replies from the document. Cascade-deletes all descendants.";
+    readonly input: z.ZodObject<{
+        comment_id: z.ZodNumber;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "compare_documents";
+    readonly description: "Compare two DOCX documents and produce a tracked-changes output document. Provide original_file_path + revised_file_path for standalone comparison, or session_id/file_path to compare session edits against the original.";
+    readonly input: z.ZodObject<{
+        original_file_path: z.ZodOptional<z.ZodString>;
+        revised_file_path: z.ZodOptional<z.ZodString>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+        save_to_local_path: z.ZodString;
+        author: z.ZodOptional<z.ZodString>;
+        engine: z.ZodOptional<z.ZodEnum<{
+            auto: "auto";
+            atomizer: "atomizer";
+            diffmatch: "diffmatch";
+        }>>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "get_footnotes";
+    readonly description: "Get all footnotes from the document with IDs, display numbers, text, and anchored paragraph IDs. Read-only.";
+    readonly input: z.ZodObject<{
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}, {
+    readonly name: "add_footnote";
+    readonly description: "Add a footnote anchored to a paragraph. Optionally position the reference after specific text using after_text. Note: [^N] markers in read_file output are display-only and not part of the editable text used by replace_text.";
+    readonly input: z.ZodObject<{
+        target_paragraph_id: z.ZodString;
+        after_text: z.ZodOptional<z.ZodString>;
+        text: z.ZodString;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "update_footnote";
+    readonly description: "Update the text content of an existing footnote.";
+    readonly input: z.ZodObject<{
+        note_id: z.ZodNumber;
+        new_text: z.ZodString;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "delete_footnote";
+    readonly description: "Delete a footnote and its reference from the document.";
+    readonly input: z.ZodObject<{
+        note_id: z.ZodNumber;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    };
+}, {
+    readonly name: "extract_revisions";
+    readonly description: "Extract tracked changes as structured JSON with before/after text per paragraph, revision details, and comments. Supports pagination via offset and limit. Read-only - does not modify the document.";
+    readonly input: z.ZodObject<{
+        offset: z.ZodOptional<z.ZodNumber>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        session_id: z.ZodOptional<z.ZodString>;
+        file_path: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}];
+export declare const SAFE_DOCX_MCP_TOOLS: {
+    name: "read_file" | "grep" | "init_plan" | "merge_plans" | "apply_plan" | "replace_text" | "insert_paragraph" | "download" | "format_layout" | "accept_changes" | "has_tracked_changes" | "get_session_status" | "clear_session" | "duplicate_document" | "add_comment" | "get_comments" | "delete_comment" | "compare_documents" | "get_footnotes" | "add_footnote" | "update_footnote" | "delete_footnote" | "extract_revisions";
+    description: "Read document content with paragraph IDs. Accepts session_id or file_path." | "Search paragraphs with regex. Accepts session_id or file_path." | "Initialize revision-bound context metadata for coordinated multi-agent planning. Accepts session_id or file_path." | "Deterministically merge multiple sub-agent plans and detect hard conflicts before apply." | "Validate and apply a batch of edit steps (replace_text, insert_paragraph) to a session document in one call. Validates all steps first; applies only if all pass. Accepts inline steps or a plan_file_path. Compatible with merge_plans output." | "Replace text in a paragraph by _bk_* id, preserving formatting. Accepts session_id or file_path." | "Insert a paragraph before/after an anchor paragraph by _bk_* id. Accepts session_id or file_path." | "Save clean and/or tracked changes output back to the user filesystem. Defaults to both clean and tracked outputs when no format override is provided. Accepts session_id or file_path." | "Apply deterministic OOXML layout controls (paragraph spacing, table row height, cell padding). Accepts session_id or file_path." | "Accept all tracked changes in the document body, producing a clean document with no revision markup. Returns acceptance stats." | "Check whether the document body contains tracked-change markers (insertions, deletions, moves, and property-change records). Read-only." | "Get session metadata. Accepts session_id or file_path." | "Clear one session, all sessions for a file path, or all sessions with explicit confirmation." | "Duplicate a source .docx and auto-open a fresh editing session for the duplicate." | "Add a comment or threaded reply to a document. Provide target_paragraph_id + anchor_text for root comments, or parent_comment_id for replies." | "Get all comments from the document with IDs, authors, dates, text, and anchored paragraph IDs. Includes threaded replies. Read-only." | "Delete a comment and all its threaded replies from the document. Cascade-deletes all descendants." | "Compare two DOCX documents and produce a tracked-changes output document. Provide original_file_path + revised_file_path for standalone comparison, or session_id/file_path to compare session edits against the original." | "Get all footnotes from the document with IDs, display numbers, text, and anchored paragraph IDs. Read-only." | "Add a footnote anchored to a paragraph. Optionally position the reference after specific text using after_text. Note: [^N] markers in read_file output are display-only and not part of the editable text used by replace_text." | "Update the text content of an existing footnote." | "Delete a footnote and its reference from the document." | "Extract tracked changes as structured JSON with before/after text per paragraph, revision details, and comments. Supports pagination via offset and limit. Read-only - does not modify the document.";
+    inputSchema: Record<string, unknown>;
+    annotations: {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: false;
+        readonly destructiveHint: true;
+    } | {
+        readonly readOnlyHint: true;
+        readonly destructiveHint: false;
+    };
+}[];
+export type SafeDocxToolName = (typeof SAFE_DOCX_TOOL_CATALOG)[number]['name'];
+//# sourceMappingURL=tool_catalog.d.ts.map

package/dist/tool_catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool_catalog.d.ts","sourceRoot":"","sources":["../src/tool_catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAqBxB,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmTa,CAAC;AAUjD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAK7B,CAAC;AAEJ,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC"}