typst-mcp

Typst MCP Server

可用工具

⚠️ 目前所有功能都以 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 应将代码渲染为图像并检查其外观是否正确。
• 仅适用于多模态模型。

快速开始

• 克隆本仓库

• 克隆 typst 仓库

• 在 typst 仓库中运行文档生成
• 确保调整路径以匹配本地克隆的 typst-mcp 仓库。
• 这将生成 main.json 文件以及 typst-docs 文件夹中的资源。

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

• 安装 Typst

运行服务器

Typst 文档的 JSON 模式

⚠️ Typst 文档的模式尚未稳定，可能随时更改。该模式从 Typst 源代码生成，不保证完整或正确。如果模式发生变化，本仓库需要相应更新，以确保文档功能正常运行。