Skip to main content
Glama

Typst MCP Server

A Model Context Protocol (MCP) server that provides Typst documentation to Claude Code and other MCP clients.

Prerequisites

  • Python 3.12 or higher

  • uv package manager

Related MCP server: microCMS Document MCP Server

Quickstart

Run the following command to add the Typst MCP server to your project-scope Claude Code configuration:

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

Or manually add it to your .mcp.json configuration file:

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

2. Start using Typst capabilities

Once configured, you can ask Claude Code to help you with Typst documentation. For example:

Add a Tabel of Contents to index.typ
Explain this Typst syntax: #set page(paper: "a4", margin: 2cm)

Documentation

Tools

Search through Typst documentation for specific topics, functions, or syntax.

Parameters:

  • query (string): Search term or phrase to find in Typst documentation

Returns: List of relevant documentation sections with titles, descriptions, and file paths.

Example:

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

typst_browse

Browse the Typst documentation structure as a hierarchical tree.

Parameters:

  • depth (integer, optional): Maximum depth to traverse (default: 0 for full depth)

  • sub_directory (string, optional): Subdirectory to explore (default: "." for root)

Returns: Tree structure of documentation files and directories.

Example:

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

typst_read

Read the content of a specific Typst documentation file.

Parameters:

  • path (string): Relative path to the documentation file

Returns: Full content of the specified documentation file in markdown format.

Example:

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

Development

Setting up development environment

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

Running tests

uv run --frozen pytest

Code formatting

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

Type checking

uv run --frozen ty

License

MIT License - see LICENSE file for details.

Available Tools

3 tools
typst_browseC

Browse the Typst documentation structure as a hierarchical tree

ParametersJSON Schema
NameRequiredDescriptionDefault
depthNoMaximum depth to traverse (default: 0 for full depth)
sub_directoryNoSubdirectory to explore (default: '.' for root).

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the output format ('hierarchical tree') but doesn't describe what the tree contains, how it's structured, whether it's read-only, or any performance considerations like rate limits or data size. This leaves significant gaps for a tool that likely returns complex documentation data.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without any redundant information. It's appropriately sized and front-loaded, with every word contributing to understanding the tool's function.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of browsing documentation as a hierarchical tree, no annotations, and no output schema, the description is incomplete. It doesn't explain what the tree output looks like, how to interpret it, or any behavioral traits, making it inadequate for an agent to use the tool effectively without trial and error.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already fully documents both parameters ('depth' and 'sub_directory') with descriptions and defaults. The description adds no additional parameter semantics beyond what the schema provides, meeting the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('browse') and resource ('Typst documentation structure') with the specific format 'as a hierarchical tree', which distinguishes it from typical file browsing. However, it doesn't explicitly differentiate from sibling tools like 'typst_read' or 'typst_search' in terms of purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'typst_read' or 'typst_search'. It lacks context about use cases, prerequisites, or exclusions, leaving the agent to infer usage based on tool names alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

typst_readC

Read the content of a specific Typst documentation file

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesRelative path to the documentation file

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is a read operation but doesn't clarify what 'read' entails—whether it returns raw content, formatted text, metadata, or error handling. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence that directly states the tool's function without any fluff. It's appropriately sized and front-loaded, with every word contributing to understanding the purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete for a tool that reads documentation files. It doesn't explain what format the content is returned in, how errors are handled, or any limitations (e.g., file size, supported formats). For a read operation with no structured output documentation, this leaves the agent with insufficient context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 100% description coverage, with the 'path' parameter documented as 'Relative path to the documentation file'. The description adds no additional parameter semantics beyond what the schema already provides, so it meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Read') and resource ('Typst documentation file'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'typst_browse' or 'typst_search', which likely also involve reading documentation content in different ways.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus its siblings ('typst_browse' and 'typst_search'). It doesn't mention prerequisites, alternatives, or exclusions, leaving the agent to infer usage context from tool names alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 3 tool updatesv1.0.0
    • First observedtypst_browse
    • First observedtypst_read
    • First observedtypst_search

TDQS

A3.5/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: browse for exploring the documentation hierarchy, read for accessing specific file content, and search for finding information by query. There is no overlap in functionality, making tool selection straightforward for an agent.

Naming Consistency5/5

All tool names follow a consistent 'typst_verb' pattern (typst_browse, typst_read, typst_search), using snake_case and clear action verbs. This predictability enhances usability and reduces cognitive load.

Tool Count5/5

With 3 tools, the server is well-scoped for its purpose of interacting with Typst documentation. Each tool serves a distinct and essential function (browse, read, search), and there are no extraneous tools, making the set efficient and focused.

Completeness5/5

The tool surface fully covers the core needs for documentation interaction: browsing the structure, reading specific content, and searching for information. This provides a complete workflow without gaps, allowing agents to navigate and retrieve documentation effectively.

Maintenance

ActivityInactive
ResponsivenessSyncing

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/FujishigeTemma/typst-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server