Typst MCP 服务器

Typst MCP 服务器是一个 MCP（模型上下文协议） 的实现，帮助 AI 模型与 Typst，一个基于标记的语言排版系统进行交互。该服务器提供了在 LaTeX 和 Typst 之间转换、验证 Typst 语法以及从 Typst 代码生成图像的工具。

可用工具

⚠️ 目前所有功能都作为 tools 实现，因为 Cursor 和 VS Code 尚无法处理其他原始功能。

服务器提供以下工具：

1. list_docs_chapters()：列出 Typst 文档中的所有章节。

   • 让 LLM 对文档有一个概览，并选择要阅读的章节。
   • LLM 应根据当前任务选择相关的章节来阅读。

2. get_docs_chapter(route)：从 Typst 文档中检索特定章节。

   • 根据 LLM 选择的章节，此工具检索章节的内容。
   • 同时也提供 get_docs_chapters(routes: list) 来一次性检索多个章节。

3. latex_snippet_to_typst(latex_snippet)：使用 Pandoc 将 LaTeX 代码转换为 Typst。

   • LLM 更擅长编写 LaTeX 而不是 Typst，因此这个工具有助于将 LaTeX 代码转换为 Typst。
   • 同时也提供 latex_snippets_to_typst(latex_snippets: list) 来一次性转换多个 LaTeX 片段。

4. check_if_snippet_is_valid_typst_syntax(typst_snippet)：验证 Typst 代码。

   • 在将 Typst 代码发送给用户之前，LLM 应检查代码是否有效。
   • 同时也提供 check_if_snippets_are_valid_typst_syntax(typst_snippets: list) 来一次性验证多个 Typst 片段。

5. typst_to_image(typst_snippet)：将 Typst 代码渲染成 PNG 图像。

   • 在将复杂的 Typst 插图发送给用户之前，LLM 应将代码渲染成图像并检查其外观是否正确。
   • 仅适用于多模态模型。

快速开始

• 克隆此仓库

  • 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

运行服务器

执行服务器脚本：

python server.py

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

mcp install server.py

或在 VS Code 中使用新的代理模式：

代理模式：对所有用户开放并支持 MCP

Typst 文档的 JSON 架构

⚠️ Typst 文档的架构不稳定，可能会随时更改。架构是从 typst 源代码生成的，不保证完整或正确。如果架构发生变化，需要相应地更新此仓库，以便文档功能再次正常工作。