Typst MCP Server

Fornece documentação do Typst para clientes MCP como Claude Code.

GitHub
9
Experimente este MCPPatrocinado

Documentação

Servidor MCP Typst

Um servidor Model Context Protocol (MCP) que fornece documentação do Typst para o Claude Code e outros clientes MCP.

Pré-requisitos

  • Python 3.12 ou superior
  • Gerenciador de pacotes uv

Início rápido

Execute o seguinte comando para adicionar o servidor MCP Typst à configuração do Claude Code no escopo do seu projeto:

claude mcp add typst-mcp -s project -- uv run --with "git+https://github.com/FujishigeTemma/typst-mcp" typst-mcp serve

Ou adicione-o manualmente ao seu arquivo de configuração .mcp.json:

{
  "mcpServers": {
    "typst-mcp": {
      "type": "stdio",
      "command": "uv",
      "args": [
        "run",
        "--with",
        "git+https://github.com/FujishigeTemma/typst-mcp"
        "typst-mcp",
        "serve"
      ],
      "env": {}
    },
  }
}

2. Comece a usar os recursos do Typst

Após a configuração, você pode pedir ao Claude Code para ajudá-lo com a documentação do Typst. Por exemplo:

Add a Tabel of Contents to index.typ

Explain this Typst syntax: #set page(paper: "a4", margin: 2cm)

Documentação

Ferramentas

typst_search

Pesquise na documentação do Typst por tópicos, funções ou sintaxe específicos.

Parâmetros:

  • query (string): termo ou frase de pesquisa para encontrar na documentação do Typst

Retorna: lista de seções relevantes da documentação com títulos, descrições e caminhos de arquivo.

Exemplo:

{
  "name": "typst_search",
  "arguments": {
    "query": "table formatting"
  }
}

typst_browse

Navegue pela estrutura da documentação do Typst como uma árvore hierárquica.

Parâmetros:

  • depth (inteiro, opcional): profundidade máxima a percorrer (padrão: 0 para profundidade total)
  • sub_directory (string, opcional): subdiretório a explorar (padrão: "." para a raiz)

Retorna: estrutura em árvore dos arquivos e diretórios da documentação.

Exemplo:

{
  "name": "typst_browse",
  "arguments": {
    "depth": 2,
    "sub_directory": "reference"
  }
}

typst_read

Leia o conteúdo de um arquivo específico da documentação do Typst.

Parâmetros:

  • path (string): caminho relativo para o arquivo de documentação

Retorna: conteúdo completo do arquivo de documentação especificado em formato markdown.

Exemplo:

{
  "name": "typst_read",
  "arguments": {
    "path": "reference/layout/table.md"
  }
}

Desenvolvimento

Configurando o ambiente de desenvolvimento

git clone https://github.com/FujishigeTemma/typst-mcp.git
cd typst-mcp
uv sync --dev

Executando testes

uv run --frozen pytest

Formatação de código

uv run --frozen ruff format .
uv run --frozen ruff check . --fix

Verificação de tipos

uv run --frozen ty

Licença

Licença MIT - consulte o arquivo LICENSE para obter detalhes.

Projetos relacionados