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 源代碼生成的，並不能保證完整或正確。如果模式發生變化，此倉庫需要相應更新，以確保文檔功能繼續正常工作。