Typst MCP

🚀 Typst MCP Server

The Typst MCP Server is an implementation of MCP (Model Context Protocol), designed to facilitate the interaction between AI models and Typst, a markup-based typesetting system. This server provides tools for converting LaTeX to Typst, validating Typst syntax, and generating images from Typst code.

🚀 Quick Start

• Clone this repository
  • git clone https://github.com/johannesbrandenburger/typst-mcp.git
• Clone the Typst repository
  • git clone https://github.com/typst/typst.git
• Run documentation generation in the Typst repository
  • cargo run --package typst-docs -- --assets-dir ../typst-mcp/typst-docs --out-file ../typst-mcp/typst-docs/main.json
    • Ensure to adjust the paths to match your local typst-mcp repository location.
    • This will generate main.json and assets in the typst-docs folder.
• Install the required dependencies: uv sync (if not already installed, install uv first).
• Install Typst

✨ Features

⚠️ Important Note

Currently, all features are implemented in the form of tools because Cursor and VS Code do not yet support other types of primitives.

The server provides the following tools:

1. list_docs_chapters(): Lists all chapters in a Typst document.

   • Enables the LLM to get an overview of the document and select chapters to read.
   • Allows the LLM to choose relevant chapters based on the task at hand.

2. get_docs_chapter(route): Retrieves the Typst document content of a specific chapter.

   • Based on the chapter selected by the LLM, this tool returns the content of that chapter.
   • Also supports get_docs_chapters(routes: list) to retrieve the content of multiple chapters at once.

3. latex_snippet_to_typst(latex_snippet): Converts LaTeX code to Typst using Pandoc.

   • Since LLMs are better at writing LaTeX, this tool helps convert LaTeX code to Typst.
   • Also supports latex_snippets_to_typst(latex_snippets: list) for batch conversion of multiple LaTeX snippets.

4. check_if_snippet_is_valid_typst_syntax(typst_snippet): Validates whether the syntax of Typst code is correct.

   • Before sending Typst code to the user, the LLM should check if the code is valid.
   • Also supports check_if_snippets_are_valid_typst_syntax(typst_snippets: list) for batch validation of multiple Typst snippets.

5. typst_to_image(typst_snippet): Renders Typst code as a PNG image.

   • Before sending complex Typst illustrations to the user, the LLM should render the code as an image and check if it is correct.
   • Only applicable to multimodal models.

💻 Usage Examples

Basic Usage

To run the server, you can use the following commands:

python server.py

Or install it using MCP in Claude Desktop:

mcp install server.py

Or use the new agent mode in VS Code:

Agent Mode: Open to all users and supports MCP

📚 Documentation

⚠️ Important Note

The schema of Typst documentation is unstable and may change at any time. This schema is generated from the Typst source code and is not guaranteed to be complete or correct. If the schema changes, this repository needs to be updated accordingly to ensure the documentation functionality continues to work properly.