Skip to content

vivekVells/mcp-pandoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mcp-pandoc: A Document Conversion MCP Server

Officially included in the Model Context Protocol servers open-source project. 🎉

Overview

A Model Context Protocol server for document format conversion using pandoc. This server provides tools to transform content between different document formats while preserving formatting and structure.

Please note that mcp-pandoc is currently in early development. PDF support is under development, and the functionality and available tools are subject to change and expansion as we continue to improve the server.

Credit: This project uses the Pandoc Python package for document conversion, forming the foundation for this project.

Demo

mcp-pandoc - v1: Seamless Document Format Conversion for Claude using MCP server

🎥 Watch on YouTube

Screenshots

Tool Demo 1 showing markdown, text, and HTML conversion Demo 2 showing markdown, text, and HTML conversion

More to come...

Tools

  1. convert-contents
    • Transforms content between supported formats
    • Inputs:
      • contents (string): Source content to convert
      • output_format (string): Target format (html, markdown, text)
    • Returns: Converted content in the target format

Supported Formats

Currently supported formats:

  • Plain text
  • Markdown
  • HTML

In development:

  • PDF, CSV, DOCX, etc.

Usage & configuration

To use the published one

{
  "mcpServers": {
    "mcp-pandoc": {
      "command": "uvx",
      "args": ["mcp-pandoc"]
    }
  }
}

Quickstart

Install

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration
"mcpServers": {
  "mcp-pandoc": {
    "command": "uv",
    "args": [
      "--directory",
      "/Users/vivekvells/Desktop/code/ai/mcp-pandoc",
      "run",
      "mcp-pandoc"
    ]
  }
}
Published Servers Configuration
"mcpServers": {
  "mcp-pandoc": {
    "command": "uvx",
    "args": [
      "mcp-pandoc"
    ]
  }
}

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /Users/vivekvells/Desktop/code/ai/mcp-pandoc run mcp-pandoc

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.


Contributing

We welcome contributions to enhance mcp-pandoc! Here's how you can get involved:

  1. Report Issues: Found a bug or have a feature request? Open an issue on our GitHub Issues page.
  2. Submit Pull Requests: Improve the codebase or add features by creating a pull request.

About

MCP server for document format conversion using pandoc.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages