HWpx

You operate the HWPX MCP Server to automate editing HWPX documents through AI tools. This server reads, edits, and saves HWPX content with strong data integrity, cross-platform compatibility, and a large set of editing capabilities. You can run the server locally and connect your MCP client to perform table edits, image insertions, style preservation, and many other document-manipulation tasks from your preferred client.

How to use

You connect to the MCP server from your chosen MCP client. The server exposes a wide range of document editing operations such as opening, modifying, saving, and querying documents. You can perform tasks like updating table cells, inserting nested tables, rendering Mermaid diagrams, and saving with integrity checks. Start by opening a document, perform the required edits through the MCP client you configured, and then save the document to preserve changes with atomic file guarantees.

How to install

Prerequisites: you need Node.js installed on your system. You will also need a working MCP client to connect to the server.

# Clone the MCP server repository
git clone https://github.com/Dayoooun/hwpx-mcp.git

# Enter the MCP server directory
cd hwpx-mcp/mcp-server

# Install dependencies
npm install

# Build the server
npm run build

Additional setup and notes

Configuration and runtime guidance are provided to help you run the server locally and connect via your MCP client. The following is a representative runtime setup you can adapt to your environment.

# Run the MCP server (example using a local path to dist index)
node C:/path/to/hwpx-mcp/mcp-server/dist/index.js

Available tools

open_document

Open an existing HWPX document and prepare it for editing.

close_document

Close a currently opened HWPX document.

save_document

Save the edited HWPX document with backup and integrity verification.

list_open_documents

List documents currently opened by the MCP server.

get_document_text

Retrieve the full text of a document.

get_document_structure

Retrieve document structure details (sections, tables, images, etc.).

set_document_metadata

Update document metadata such as title or author.

get_word_count

Get word and character counts for a document.

get_paragraphs

List paragraphs with texts and styles for a document.

update_paragraph_text

Modify the text content of a specific paragraph.

insert_paragraph

Insert a new paragraph at a specified location.

delete_paragraph

Delete a specific paragraph.

copy_paragraph

Copy a paragraph to a new location.

move_paragraph

Move a paragraph to a new location.

get_text_style

Query text styling attributes like font, size, and color.

set_text_style

Apply text styling attributes to a text run.

get_paragraph_style

Query paragraph styling such as alignment and line spacing.

set_paragraph_style

Apply paragraph styling attributes.

search_text

Search document text with optional regex and table inclusion.

replace_text

Replace text with optional regex matching.

render_mermaid

Render Mermaid diagrams as images and insert into the document.

get_tables

List all tables in a document.

get_table

Retrieve all data from a specific table.

get_table_cell

Read a specific table cell's content.

update_table_cell

Update a table cell while preserving styles.

set_cell_properties

Configure cell properties like width and background.

insert_table

Insert a new table into a section.

insert_table_row

Add a new row to a table.

delete_table_row

Remove a row from a table.

insert_table_column

Insert a new column into a table.

delete_table_column

Delete a column from a table.

insert_nested_table

Insert a nested table inside a table cell.

get_table_as_csv

Export a table to CSV format.

get_page_settings

Query page settings like size and margins.

set_page_settings

Modify page settings for a document or section.

get_images

List all images embedded in a document.

insert_image

Insert an image into a document at a specific location.

update_image_size

Change an image's width and height.

delete_image

Remove an image from the document.

get_header

Read the header content for a section.

set_header

Set header text for a section or pages.

get_footer

Read the footer content for a section.

set_footer

Set footer text for a section or pages.

get_footnotes

List all footnotes in a document.

insert_footnote

Insert a footnote at a given location.

get_endnotes

List all endnotes in a document.

insert_endnote

Insert an endnote at a given location.

get_bookmarks

List all bookmarks in a document.

insert_bookmark

Insert a bookmark at a specific location.

get_hyperlinks

List all hyperlinks in a document.

insert_hyperlink

Insert a hyperlink at a specific location.

get_equations

List all equations in a document.

insert_equation

Insert an equation using HWP equation scripting.

get_memos

List all memos or comments.

insert_memo

Insert a memo or comment at a location.

delete_memo

Delete a memo or comment by id.

get_sections

List all sections in the document.

insert_section

Insert a new section after a given index.

delete_section

Delete a section by index.

get_section_xml

Retrieve the raw XML of a section.

set_section_xml

Replace a section’s XML with new XML.

get_styles

List defined styles in the document.

get_char_shapes

List character shape definitions.

get_para_shapes

List paragraph shape definitions.

apply_style

Apply a style to a paragraph.

get_column_def

Read column definitions for a section.

set_column_def

Change column layout for a section.

export_to_text

Export the document to a plain text file.

export_to_html

Export the document to HTML.

undo

Undo the last change.

redo

Redo the last undone change.