Typst MCP

🚀 Typst MCP 服务器

Typst MCP 服务器是一个 MCP（模型上下文协议） 实现，旨在助力 AI 模型与 Typst 进行交互。Typst 是一个基于标记的排版系统。该服务器提供了一系列工具，可实现将 LaTeX 转换为 Typst、验证 Typst 语法以及根据 Typst 代码生成图像等功能。

🚀 快速开始

克隆仓库

• 克隆此仓库：

  git clone https://github.com/johannesbrandenburger/typst-mcp.git
  

• 克隆 Typst 仓库：

  git clone https://github.com/typst/typst.git
  

生成文档

在 Typst 仓库中运行文档生成：

cargo run --package typst-docs -- --assets-dir ../typst-mcp/typst-docs --out-file ../typst-mcp/typst-docs/main.json

• 确保调整路径以匹配您本地的 typst-mcp 仓库位置。
• 这将生成 main.json 和 typst-docs 文件夹中的资产。

安装依赖

安装所需的依赖项：uv sync（如果尚未安装，请先安装 uv）。

安装 Typst

请安装 Typst。

运行服务器

• 运行服务器脚本：

  python server.py
  

• 或在 Claude Desktop 中使用 MCP 安装：

  mcp install server.py
  

• 或使用 VS Code 的新代理模式： 代理模式：向所有用户开放且支持 MCP

✨ 主要特性

可用工具

⚠️ 重要提示

当前所有功能都以 tools 的形式实现，因为 Cursor 和 VS Code 尚未支持其他类型的原语。

服务器提供的工具如下：

1. list_docs_chapters()：列出 Typst 文档中的所有章节。
   • 让 LLM 获取文档的概览并选择要阅读的章节。
   • LLM 可以根据手头的任务选择相关章节进行阅读。
2. get_docs_chapter(route)：获取特定章节的 Typst 文档内容。
   • 基于 LLM 选定的章节，此工具会返回该章的内容。
   • 同时支持 get_docs_chapters(routes: 列表) 用于一次性获取多个章节的内容。
3. latex_snippet_to_typst(latex_snippet)：使用 Pandoc 将 LaTeX 代码转换为 Typst。
   • LLM 更擅长编写 LaTeX，因此此工具可以帮助将 LaTeX 代码转换为 Typst。
   • 同时支持 latex_snippets_to_typst(latex_snippets: 列表) 用于批量转换多个 LaTeX 片段。
4. check_if_snippet_is_valid_typst_syntax(typst_snippet)：验证 Typst 代码的语法是否正确。
   • 在将 Typst 代码发送给用户之前，LLM 应检查代码是否有效。
   • 同时支持 check_if_snippets_are_valid_typst_syntax(typst_snippets: 列表) 用于批量验证多个 Typst 片段。
5. typst_to_image(typst_snippet)：将 Typst 代码渲染为 PNG 图像。
   • 在发送复杂的 Typst 插图给用户之前，LLM 应将代码渲染为图像并检查其是否正确。
   • 仅适用于多模态模型。

📚 详细文档

Typst 文档的 JSON 模式

⚠️ 重要提示

Typst 文档的模式是不稳定的，可能会随时更改。此模式是从 Typst 源代码生成的，并不能保证完整或正确。如果模式发生变化，此仓库需要相应更新，以确保文档功能继续正常工作。