Typst MCP Server
Provides access to Typst documentation through search, browsing, and reading capabilities, enabling assistance with Typst syntax, functions, and typesetting features.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Typst MCP Server how do I create a table with custom borders?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
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 serveOr 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.typExplain this Typst syntax: #set page(paper: "a4", margin: 2cm)Documentation
Tools
typst_search
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 --devRunning tests
uv run --frozen pytestCode formatting
uv run --frozen ruff format .
uv run --frozen ruff check . --fixType checking
uv run --frozen tyLicense
MIT License - see LICENSE file for details.
Related Projects
Typst - The Typst typesetting system
MCP Python SDK - Model Context Protocol SDK for Python
Claude Code - AI-powered coding assistant
Available Tools
3 toolstypst_browseC
Browse the Typst documentation structure as a hierarchical tree
Inputs: depth, sub_directory.
typst_readC
Read the content of a specific Typst documentation file
Inputs: path (required).
typst_searchC
Search through Typst documentation for specific topics, functions, or syntax
Inputs: query (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
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.
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.
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.
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
Related MCP Connectors
Search and read Rust documentation for the standard library and any crate on crates.io
Tailor Platform for AI assistants: search, list and read the platform documentation.
Search and query nTop's knowledge base and engineering guides from AI applications.
Search and read Vector Panda docs: API operations, pricing, storage tiers, measured benchmarks.
Related MCP Servers
- AlicenseAqualityDmaintenanceProvides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context.71MIT
- AlicenseAqualityCmaintenanceProvides access to microCMS documentation, enabling AI assistants to search and retrieve the latest document content.43247 npm8MIT
- AlicenseAqualityDmaintenanceEnables AI models to search, browse, and retrieve full content of OpenCode documentation pages.35MIT
- FlicenseNot gradedqualityDmaintenanceEnables searching and fetching documentation pages from a wide range of programming languages, frameworks, game engines, and tools. Supports multiple sources and returns relevant documentation snippets.1-