
zig-wasm/zig-mcp
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
Сервер Model Context Protocol (MCP), который предоставляет актуальную документацию по стандартной библиотеке языка программирования Zig и встроенным функциям
Обзор
Сервер Model Context Protocol (MCP), который предоставляет актуальную документацию по стандартной библиотеке языка программирования Zig, а также встроенные функции. Он использует тот же подход, что и официальный autodoc (ziglang.org Zig), считывая исходные файлы STD lib напрямую через WASM-модуль. Однако вместо возврата HTML он выводит Markdown, что значительно снижает использование токенов. По умолчанию сервер использует ваш локально установленный компилятор Zig, чтобы отобрать документацию, чтобы вы всегда получали документы, соответствующие вашей реальной версии Zig. Он также может загружать документацию из ziglang.org при необходимости. Добавьте использовать zigdocs к своему запросу, если хотите явно указать LLM использовать инструменты Zig docs. В противном случае LLM автоматически решит, когда использовать инструменты MCP, исходя из контекста ваших вопросов. - - Перечисляет все доступные встроенные функции Zig. Встроенные функции предоставляются компилятором и имеют префикс '@'.
Обзор (машинный перевод)
Сервер Model Context Protocol (MCP), который предоставляет актуальную документацию по стандартной библиотеке языка программирования Zig, а также встроенные функции.
Он использует тот же подход, что и официальный autodoc (ziglang.org Zig), считывая исходные файлы STD lib напрямую через WASM-модуль. Однако вместо возврата HTML он выводит Markdown, что значительно снижает использование токенов.
По умолчанию сервер использует ваш локально установленный компилятор Zig, чтобы отобрать документацию, чтобы вы всегда получали документы, соответствующие вашей реальной версии Zig. Он также может загружать документацию из ziglang.org при необходимости.
[! СОВЕТ] Добавьте
use zigdocsв свой запрос, если хотите явно указать LLM использовать инструменты Zig docs. В противном случае LLM автоматически решит, когда использовать инструменты MCP, исходя из контекста ваших вопросов.
Инструменты
list_builtin_functions— Перечисляет все доступные встроенные функции Zig. Встроенные функции предоставляются компилятором и имеют префикс ‘@’. Ключевое слово comptime на параметре означает, что параметр должен быть известен на момент компиляции. Используйте это, чтобы определить, какие функции доступны, затем используйте ‘get_builtin_function’ для получения подробной документации.
Эта страница переведена автоматически. Технические детали смотрите в оригинале.
README
Показан фрагмент оригинального README. Открыть оригинал.
Zig Docs MCP
Model Context Protocol (MCP) server that provides up-to-date documentation for the Zig programming language standard library and builtin functions.
It uses the same approach as Zig’s official autodoc (ziglang.org) by reading STD lib source files directly through a WASM module. However instead of returning HTML, it outputs Markdown which significantly reduces token usage.
By default, the server uses your locally installed Zig compiler to serve documentation, ensuring you always get docs that match your actual Zig version. It can also fetch documentation from ziglang.org if needed.
[!TIP] Add
use zigdocsto your prompt if you want to explicitly instruct the LLM to use Zig docs tools. Otherwise, LLM will automatically decide when to utilize MCP tools based on the context of your questions.
Tools
list_builtin_functions- Lists all available Zig builtin functions. Builtin functions are provided by the compiler and are prefixed with ‘@’. The comptime keyword on a parameter means that the parameter must be known at compile time. Use this to discover what functions are available, then use ‘get_builtin_function’ to get detailed documentation.get_builtin_function- Search for Zig builtin functions by name and get their documentation, signatures, and usage information. Returns all matching functions ranked by relevance.search_std_lib- Search the Zig standard library for declarations by name. Returns a list of matching items with their fully qualified names. Use this to discover available types, functions, and constants in the standard library.get_std_lib_item- Get detailed documentation for a specific standard library item by its fully qualified name (e.g., “std.ArrayList.init”). Returns comprehensive documentation including function signatures, parameters, errors, examples, and source code. Setget_source_file: trueto retrieve the entire source file where the item is implemented.
Commands
The CLI provides flexible options for version control and update management:
# Start MCP server
zig-mcp --doc-source local
# Use specific Zig version from ziglang.org instead of local Zig
zig-mcp --doc-source remote --version 0.14.1
# Enable automatic daily updates
zig-mcp --doc-source remote --update-policy daily
# Update documentation without starting MCP server (only for remote)
zig-mcp update --version 0.15.1
# Start local web server to view documentation
zig-mcp view --version 0.15.1
Version options --version:
master(default) - Latest development version from Zig’s master branch0.14.1,0.14.0, etc. - Specific Zig release versions
Update policies --update-policy:
Установка
npx -y zig-mcp@latestКонфигурация
{
"mcpServers": {
"zig-docs": {
"command": "npx",
"args": ["-y", "zig-mcp@latest"]
}
}
}