Command Palette

Search for a command to run...

UnylyUnyly
Browse all

Spire Doc

FreeNot checked

Spire.Doc MCP Server, empowering AI agents to work with Word files

GitHubEmbed

About

Spire.Doc MCP Server, empowering AI agents to work with Word files

README

Spire.Doc MCP Server is a Model Context Protocol (MCP) server that enables you to manipulate Word documents without requiring Microsoft Word. With it, you can create, read, and modify Word documents directly using your AI agent.

Key Features

Quick Start

Prerequisites

  • Python 3.10 or higher

Installation

  1. Clone the repository:
git clone https://github.com/eiceblue/spire-doc-mcp-server.git
cd spire-doc-mcp-server
  1. Install using uv:
uv pip install -e .

Running the Server

Start the server (default port 8000):

uv run spire-doc-mcp-server

Custom port (e.g., 8080):

# Bash/Linux/macOS
export SPIRE_DOC_MCP_PORT=8080 && uv run spire-doc-mcp-server

# Windows PowerShell
$env:SPIRE_DOC_MCP_PORT = "8080"; uv run spire-doc-mcp-server

Integration with AI Tools

Cursor IDE

  1. Add this configuration to Cursor:
{
  "mcpServers": {
    "word": {
      "url": "http://localhost:8000/sse",
      "env": {
        "WORD_FILES_PATH": "/path/to/word/files"
      }
    }
  }
}
  1. The Word tools will be available through your AI assistant.

Environment Variables

Variable Description Default
WORD_FILES_PATH Directory for Word files ./word_files

Available Tools

The server provides 18 tools organized into 5 categories:

Document Operations (6 tools)

  • create_document: Create new Word documents with optional templates
  • set_document_protection: Apply password protection to documents
  • find_and_replace: Search and replace text in documents
  • merge_documents: Merge multiple documents into one
  • add_text_watermark: Add text watermarks to documents

Paragraph Operations (5 tools)

  • get_paragraph_text: Retrieve text content from paragraphs
  • delete_paragraph: Remove paragraphs from documents
  • get_paragraph_info: Get detailed paragraph information
  • add_paragraph: Add new paragraphs to documents
  • update_paragraph_text: Modify paragraph text content

Table Operations (6 tools)

  • create_table: Create new tables with specified dimensions
  • add_table_after_paragraph: Insert tables after specific paragraphs
  • add_table_to_section: Add tables to the end of sections
  • get_table_info: Get table information and structure
  • delete_table: Remove tables from documents
  • set_cell_text: Set text content in table cells

Formatting Operations (2 tools)

  • format_paragraph: Apply formatting to paragraphs (alignment, indentation, spacing)
  • get_paragraph_format: Retrieve paragraph formatting information

Conversion Operations (3 tools)

  • convert_document: Convert documents between different formats
  • get_conversion_status: Check conversion operation status
  • get_conversion_history: View conversion history

Supported Formats

Input Formats

  • DOC: Microsoft Word 97-2003 Document
  • DOCX: Microsoft Word 2007+ Document
  • DOCM: Microsoft Word 2007+ Macro-Enabled Document
  • DOT: Microsoft Word 97-2003 Template
  • DOTX: Microsoft Word 2007+ Template
  • DOTM: Microsoft Word 2007+ Macro-Enabled Template

Output Formats

  • DOC: Microsoft Word 97-2003 Document
  • DOCX: Microsoft Word 2007+ Document
  • PDF: Portable Document Format
  • RTF: Rich Text Format
  • HTML: HyperText Markup Language
  • TXT: Plain Text
  • EPUB: Electronic Publication
  • ODT: OpenDocument Text
  • XML: Extensible Markup Language
  • Markdown: Markdown Format

Development

Project Structure

spire-doc-mcp-server/
├── src/spire_doc_mcp/
│   ├── api/                 # API layer (18 tools)
│   │   ├── document_tools.py
│   │   ├── paragraph_tools.py
│   │   ├── table_tools.py
│   │   ├── format_tools.py
│   │   └── conversion_tools.py
│   ├── core/               # Core business logic
│   │   ├── document.py
│   │   ├── paragraph.py
│   │   ├── table.py
│   │   ├── format.py
│   │   ├── conversion.py
│   │   └── base.py
│   ├── utils/              # Utilities and constants
│   │   ├── exceptions.py
│   │   └── constants.py
│   ├── server.py           # MCP server implementation
│   └── __main__.py         # Entry point
├── pyproject.toml          # Project configuration
├── README.md              # This file
└── TOOLS.md               # Detailed tool documentation

Running Tests

uv run pytest

Code Quality

The project follows Python best practices:

  • Type hints throughout
  • Comprehensive error handling
  • Consistent code formatting
  • Detailed documentation
  • Modular architecture

Documentation

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support and questions:

  • Check the TOOLS.md documentation
  • Review the error handling section
  • Open an issue on GitHub

Version History

  • v1.0.0: Initial stable release with 18 tools
  • Complete Word document manipulation capabilities
  • Comprehensive error handling
  • Full format conversion support

from github.com/eiceblue/spire-doc-mcp-server

Installing Spire Doc

This server has no published package — it is built from source. Open the repository and follow its README.

▸ github.com/eiceblue/spire-doc-mcp-server

FAQ

Is Spire Doc MCP free?

Yes, Spire Doc MCP is free — one-click install via Unyly at no cost.

Does Spire Doc need an API key?

No, Spire Doc runs without API keys or environment variables.

Is Spire Doc hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install Spire Doc in Claude Desktop, Claude Code or Cursor?

Open Spire Doc on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Compare Spire Doc with

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All ai MCPs