Skip to main content
Glama
gbrlpzz

zig-docs-mcp

by gbrlpzz

zig-docs-mcp

Локальный MCP-сервер с открытым исходным кодом + навыки агента, которые предоставляют всегда актуальную официальную документацию Zig для последнего релиза, курируемый корпус рекомендаций по высокопроизводительному легковесному ПО и безопасное автообновление с предварительным пробным запуском для устаревшего локального инструментария Zig.

zig-docs-mcp
├── zigdocs                 MCP server (stdio, local, no accounts)
├── guidance/               curated performance guidance (12 topics)
├── skills/zig-docs         agent skill: operating rules for Zig work
└── skills/zig-docs-mcp     agent skill: Python integration (`zdoc` singleton)

Zig быстро меняется, и ответы из памяти обучения устаревают между минорными релизами — в 0.16 заменили весь слой ввода-вывода и перенесли Dir из std.fs в std.Io. Этот сервер загружает официальную документацию и исходники std при каждом вызове (с повторной проверкой по короткому TTL), поэтому каждый ответ ссылается на версию, из которой он получен. Когда ваш локальный компилятор отстаёт от документации, сервер сообщает об этом и предлагает обновление с подтверждением. Он никогда не изменяет вашу систему без явного согласия.


Содержание

  1. Зачем

  2. Как поддерживается актуальность

  3. Требования

  4. Установка сервера

  5. Подключение MCP-клиента

  6. Интеграция с Prime Agent

  7. Справочник инструментов MCP

  8. Автообновление инструментария

  9. Корпус рекомендаций

  10. Конфигурация

  11. Разработка

  12. Устранение неполадок

  13. Лицензия


Related MCP server: Zignet

Зачем

  • Документация быстро устаревает. Структура стандартной библиотеки Zig меняется между минорными релизами. Обслуживание реальных исходников последнего релиза — единственный честный источник истины об API. zig_std разрешает символы, обходя реальные реэкспорты в опубликованном дереве, а не по снимку.

  • Советы по производительности должны быть механическими. Встроенный корпус объясняет стратегию выделения памяти, компоновку данных, comptime, размер бинарника, задержку запуска, SIMD, конкурентность и бенчмаркинг — на основе реального поведения оборудования и среды выполнения (линии кэша, системные вызовы, страничные прерывания), а не общих соображений.

  • Устаревший компилятор незаметно обесценивает всё. zig_version_status сравнивает ваш инструментарий с индексом вышестоящего репозитория при каждой проверке, а zig_update предлагает конкретный, проверяемый план обновления.

  • Всё локально. Сервер работает на вашей машине через stdio. Никаких учётных записей, токенов и телеметрии. Сеть используется только для ziglang.org: документация, примечания к выпускам и архивы исходников.

Как поддерживается актуальность

  • Кэшированные ответы повторно проверяются на ziglang.org, если они старше 6 часов (force=true выполняет проверку немедленно). Повторная проверка использует условные GET-запросы (ETag / Last-Modified), поэтому она дёшева.

  • Работа в офлайне: если сеть недоступна, кэшированное содержимое отдаётся с флагом stale вместо ошибки. (Первый запуск требует сети один раз.)

  • Исходники std берутся из официального архива src для каждого релиза — каноническое содержимое, даже если теги релизов на GitHub отстают (0.16.0 не был отмечен на GitHub на момент создания). Архив загружается один раз для каждой версии, извлекается только lib/std/**.

  • Параметр channel выбирает stable (последний релиз, по умолчанию) или master (ночная сборка), что позволяет просматривать изменения следующего релиза.

Структура кэша (~/.cache/zig-docs-mcp/, переопределяется через ZIG_DOCS_MCP_CACHE):

~/.cache/zig-docs-mcp/
├── http/                    upstream bodies + ETag/Last-Modified metadata
├── langref-0.16.0.json      parsed reference sections (per version)
├── notes-0.16.0.json        release-notes digest
├── zig-0.16.0-src.tar.xz    source tarball cache
└── src/0.16.0/lib/std/      extracted std sources (550 files)

Требования

  • Python ≥ 3.10 и uv

  • macOS или Linux (автообновление поддерживает Homebrew и автономные установки; для Windows выводится рабочий план, но стратегии для архивов пока нет)

  • Доступ к ziglang.org для первых загрузок и повторных проверок

Установка сервера

git clone https://github.com/gbrlpzz/zig-docs-mcp
cd zig-docs-mcp
uv tool install .          # installs the `zigdocs` command on your PATH
zigdocs --help             # verify

Не хотите устанавливать? Запустите прямо из клона:

uv run --project ~/zig-docs-mcp zigdocs

Подключение MCP-клиента

Любой MCP-клиент, поддерживающий stdio. Укажите команду zigdocs:

{
  "mcpServers": {
    "zig-docs": {
      "command": "zigdocs"
    }
  }
}

Без глобальной установки используйте клон напрямую:

{
  "mcpServers": {
    "zig-docs": {
      "command": "uv",
      "args": ["run", "--project", "/path/to/zig-docs-mcp", "zigdocs"]
    }
  }
}

Интеграция с Prime Agent

В этом репозитории два навыка. Создайте символические ссылки и перезапустите сеанс (или выполните /reload):

ln -sfn ~/zig-docs-mcp/skills/zig-docs     ~/.agents/skills/zig-docs
ln -sfn ~/zig-docs-mcp/skills/zig-docs-mcp ~/.agents/skills/zig-docs-mcp

Затем из ядра агента:

from zig_docs_mcp import zdoc

await zdoc.zig_version_status()                       # local vs latest upstream
await zdoc.zig_update()                               # dry-run upgrade plan
await zdoc.zig_update(dry_run=False, confirm=True)    # apply after user agrees
await zdoc.zig_langref(section="Errors")              # fresh language reference
await zdoc.zig_std(symbol="std.heap.ArenaAllocator")  # std docs from released source
await zdoc.zig_changelog()                            # what changed in the release
await zdoc.perf_guidance(topic="allocation-strategy") # curated guidance
await zdoc.zig_search(query="vectorization")          # search everything at once

Вызовы возвращают результат в виде JSON-строки (полные руководства возвращают необработанный Markdown); используйте json.loads(...), когда нужны такие поля, как version или docs. Аргументы — только ключевые. Команда сервера разрешается в порядке: ZIG_DOCS_MCP_CMD, zigdocs из PATH, затем uv run --project для ZIG_DOCS_MCP_REPO (по умолчанию ~/zig-docs-mcp).

skills/zig-docs/SKILL.md содержит правила, которым следует агент: сначала проверка версии, документация перед кодом, указание версии документации и никаких обновлений без явного согласия пользователя.

Справочник инструментов MCP

zig_version_status

Сравнивает локальную zig version с последним вышестоящим релизом.

{
 "local_version": "0.16.0",
 "local_path": "/opt/homebrew/bin/zig",
 "latest_stable": "0.16.0",
 "master": "0.17.0-dev.1818+7051f8e73",
 "up_to_date": true
}

Если локальный инструментарий устарел, ответ добавляет behind и suggestion, указывающий на zig_update (иллюстративный пример):

{
 "local_version": "0.15.2",
 "latest_stable": "0.16.0",
 "up_to_date": false,
 "behind": "local 0.15.2 < latest 0.16.0",
 "suggestion": "Call the zig_update tool (dry-run first) to upgrade the local toolchain to the latest stable release."
}

zig_update

Обновляет локальный инструментарий. По умолчанию — пробный запуск: выводится точный план, ничего не меняется. Для применения требуются dry_run=false, confirm=true. См. Автообновление инструментария.

zig_langref

Официальное языковое руководство, загружается свежим для версии канала.

  • section="Errors" → полный текст раздела (с сохранением блоков кода):

### Error Set Type
An error set is like an enum. However, each error name across the entire
compilation gets assigned an unsigned integer greater than 0. ...
  • query="vector" → ранжированные совпадения по разделам:

[{"section_id": "Vectors", "title": "Vectors§"},
 {"section_id": "Builtin-Functions", "title": "Builtin Functions§"}]
  • без аргументов → список всех идентификаторов разделов.

zig_std

Документация стандартной библиотеки из точного исходного кода релиза. Разрешение символов обходит реальные реэкспорты (std.zig → heap.zig → heap/ArenaAllocator.zig), следует псевдонимам @import и возвращает документацию /// и текст объявления из этого релиза:

{
 "symbol": "std.ArrayList",
 "version_source": "0.16.0",
 "file": "lib/std/std.zig",
 "line": 49,
 "declaration": "pub fn ArrayList(comptime T: type) type {\n    return array_list.Aligned(T, null);\n}",
 "docs": "A contiguous, growable list of items in memory. This is a wrapper around a\nslice of `T` values. ..."
}

Если имя не является простым объявлением верхнего уровня в обойдённом пространстве имён (компоновка меняется между релизами), инструмент переключается на поиск по всему корпусу объявлений верхнего уровня, сначала лучшие совпадения — например, std.fs.Dir в 0.16 корректно находит lib/std/Io/Dir.zig. query="arena" ищет непосредственно в комментариях документации std.

zig_changelog

Сводка примечаний к выпуску для текущей версии канала: заголовки разделов и краткое описание каждого. Полезно сразу после выхода релиза (zig_changelog(force=true)).

perf_guidance

Курируемые рекомендации по высокопроизводительному лёгкому ПО. Без аргументов выводит список тем; topic="allocation-strategy" возвращает полное руководство (необработанный Markdown с разделами «Принцип / Механика / Идиомы Zig / Антипаттерны / Эмпирические правила»); query=... ищет по всем руководствам.

Единый поиск по языковому руководству, комментариям документации std и рекомендациям:

{"query": "vectorization", "langref": [...], "guidance": [...], "std": [...], "std_version": "0.16.0"}

scope сужает область: all (по умолчанию) | langref | std | guidance.

Автообновление инструментария

zig_update выбирает стратегию автоматически:

  1. zig под управлением Homebrew (бинарник находится в префиксе brew) → brew upgrade zig:

{
 "mode": "dry-run (nothing changed). Re-run with confirm=true to apply.",
 "target_version": "0.16.0",
 "current": "0.16.0",
 "strategy": "homebrew",
 "command": ["brew", "upgrade", "zig"],
 "note": "Homebrew formula may lag the newest release slightly."
}
  1. Автономная установка (официальный архив, любое другое расположение) → загружает архив для платформы из индекса вышестоящего репозитория, распаковывает в ~/.local/opt/zig-<version> и создаёт симлинк ~/.local/bin/zig:

{
 "strategy": "standalone-tarball",
 "download": "https://ziglang.org/download/0.16.0/zig-aarch64-macos-0.16.0.tar.xz",
 "install_dir": "~/.local/opt/zig-0.16.0",
 "steps": ["download ...", "extract ...", "symlink ~/.local/bin/zig -> .../zig/zig"],
 "activation": "~/.local/bin is first on PATH; new zig takes effect immediately"
}

Если ~/.local/bin не первым в PATH, план явно сообщает об этом — иначе старый компилятор будет иметь приоритет, и инструмент подскажет, как исправить порядок.

Правила безопасности:

  • По умолчанию — пробный запуск. Ничего не загружается, не перемещается и не связывается.

  • Для применения требуются dry_run=false, confirm=true вместе.

  • Агентам, использующим этот сервер, предписано показывать план и получать явное согласие пользователя перед подтверждением.

Корпус рекомендаций

Двенадцать тем в guidance/, поставляются в составе пакета и обслуживаются через perf_guidance. Принципы универсальны; фрагменты относятся к эпохе Zig 0.16; точная истина API всегда берётся из zig_std, а не из корпуса.

Тема

Краткое описание

allocation-strategy

Согласуйте аллокатор с временем жизни; стоимость пузырькового аллокатора против учёта общего аллокатора; скрытые аллокации.

data-oriented-design

SoA против AoS: байтовая математика для 64-байтовых строк кэша; разделение горячих/холодных данных; MultiArrayList.

comptime-over-runtime

Результаты comptime становятся rodata/немедленными значениями; таблицы времени выполнения стоят грязных страниц.

zero-copy-parsing

Срезы занимают 16 байт; выделение на токен стоит аллокации, memcpy и строк кэша на токен.

binary-size

Размер = достижимость; strip, режимы паники, гигиена зависимостей; меньший текст = меньше страничных прерываний при запуске.

startup-latency

Нет init_array, ленивые страничные прерывания, ленивая инициализация, никакой работы до argv.

memory-layout

Математика выравнивания, порядок полей, упакованные структуры, @sizeOf в comptime-проверках.

simd-and-vectorization

Блокировки автовекторизации, накопление по полосам + одно свёртывание, @select против ветвлений.

concurrency-and-io

Стоимость MESI для общих записей, парковка futex, пакетирование системных вызовов, выравнивание для ложного разделения.

error-handling-cost

Ошибки — это значения u16; try — предсказуемая ветвь; без раскрутки стека.

benchmarking-methodology

Release-сборки, прогрев, минимум/медиана вместо среднего, приём результатов для обхода DCE, счётчики.

dependency-lightweightness

Сначала std; зависимости добавляют связываемый код и хрупкость сборки; вендоринг небольших утилит.

Конфигурация

Переменная

Значение

По умолчанию

ZIG_DOCS_MCP_CACHE

каталог кэша

~/.cache/zig-docs-mcp

ZIG_DOCS_MCP_CMD

полная командная строка сервера (переопределяет навык)

—

ZIG_DOCS_MCP_REPO

каталог репозитория для запасного uv run

~/zig-docs-mcp

Разработка

make sync    # deps
make test    # unit tests (offline; std-source tests skip without warm cache)
make e2e     # spawns the real server over stdio, calls every tool
make fmt     # ruff format + check

Для e2e-тестов при первом запуске требуется сеть (прогрев кэша). Модульные тесты, проверяющие разрешение символов, работают с тёплым кэшем исходников std и корректно пропускаются при его отсутствии.

Устранение неполадок

  • zigdocs server not found (навык Prime Agent): установите с помощью uv tool install . из клона или задайте ZIG_DOCS_MCP_REPO как путь к клону, или ZIG_DOCS_MCP_CMD как полную командную строку.

  • Первый запуск не работает в офлайне: кэш изначально пуст; один раз загрузитесь в сети. После этого запасной вариант с устаревшим кэшем обеспечивает работу всех инструментов.

  • Результаты выглядят устаревшими после нового релиза: передайте force=true (иначе действует TTL 6 часов).

  • zig version по-прежнему старая после обновления: нужна новая оболочка, и ~/.local/bin должен предшествовать предыдущему каталогу установки в PATH. План пробного запуска точно укажет ситуацию для вашей машины.

  • Homebrew zig отстаёт от новейшего релиза: формулы brew отстают от релизов; используйте автономную стратегию (удалите формулу brew, установите автономно), если нужны версии в день выхода.

Лицензия

MIT — см. LICENSE.

Available Tools

7 tools
perf_guidanceA

Curated guidance for high-performance lightweight software (Zig-first).

topic=None lists topics. topic='allocation-strategy' returns the guide. query searches across all guides. Principles are universal; snippets are Zig 0.16-era; verify exact APIs with zig_std.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryNo
topicNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the burden. It discloses a limitation: snippets are Zig 0.16-era and advises verifying with zig_std. It also notes principles are universal, implying portability. These are behavioral traits beyond a simple 'getter'. It does not explicitly state it is read-only, but the 'curated guidance' framing implies a non-mutating operation.

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 three short sentences, front-loading purpose and then usage. No redundant content; every sentence adds value. It packs routing and caveats efficiently.

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

Completeness4/5

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

Given the tool's simplicity and existing output schema (which covers return format), the description covers usage modes and limitations. It does not specify whether query and topic can be combined, but that is a minor gap. Overall, sufficient for correct invocation.

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

Parameters4/5

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

Schema has 0% coverage, so the description must explain parameters. It does: topic=None lists topics, topic='allocation-strategy' returns the guide, query searches across guides. This gives actionable meaning to both params, though it doesn't enumerate all topic values—acceptable because it instructs how to discover them.

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

Purpose5/5

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

The description states it provides 'Curated guidance for high-performance lightweight software (Zig-first)', a specific resource type. It distinguishes from siblings like zig_std (API reference) and zig_search (search) by focusing on performance guidance. The usage examples (topic listing, specific topic retrieval, query search) further clarify its role.

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

Usage Guidelines5/5

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

Explicitly explains how to use without params (topic=None lists topics), with a specific topic (topic='allocation-strategy' returns the guide), and with query (searches across all guides). It also points to zig_std for API verification, indicating when not to rely on this tool for exact APIs. This is clear routing to an alternative.

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

zig_changelogC

Release-notes digest for the current channel version: what changed.

ParametersJSON Schema
NameRequiredDescriptionDefault
forceNo
channelNostable

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations, the description must fully disclose behavioral traits. It only states the output ('release-notes digest') but not whether the operation is read-only, whether it makes network calls, whether the 'force' parameter triggers a refresh, or if there are any side effects. This minimal disclosure leaves significant ambiguity for a fetch-style tool.

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

Conciseness4/5

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

The description is a single, concise sentence that is front-loaded with the core purpose. It is efficient and easy to parse. However, it omits parameter information, making it less complete though still appropriately sized for the tool's simplicity.

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 two optional parameters and an output schema, the description should explain what both parameters do and when to set them. It does neither. The output schema exists, so return format is covered, but the parameter semantics are entirely missing. The tool is simple, yet the description fails to equip the agent to use it correctly.

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

Parameters1/5

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

The input schema has two parameters (force, channel) but neither has a description, and the schema coverage is 0%. The description does not mention these parameters at all, so the agent has no explanation of what 'force' or 'channel' control. This is a critical gap for a tool with optional parameters.

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

Purpose5/5

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

The description clearly states the tool's purpose: it provides a digest of release notes for the current version of a given channel. The phrase 'what changed' conveys the specific information returned. This distinguishes it from sibling tools like zig_version_status (version info), zig_update (update action), and zig_search (search).

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?

There is no guidance on when to use this tool versus alternatives. It does not mention any situational context, such as 'use this to see recent changes' or 'for details on a specific version use zig_search'. No exclusions or comparisons to siblings are provided.

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

zig_langrefB

Official Zig Language Reference, fetched fresh for the channel version.

section= returns that full section. query= searches sections. Neither lists all section ids. channel: 'stable' (latest release) or 'master'.

ParametersJSON Schema
NameRequiredDescriptionDefault
forceNo
queryNo
channelNostable
sectionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.2/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 'fetched fresh' implying network/caching behavior, and clarifies channel versions, but it does not explain the force parameter, potential side effects, rate limits, or what happens when both section and query are provided. Significant behavioral gaps remain.

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

Conciseness4/5

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

The description is concise, front-loaded with the purpose, and each sentence earns its place. It is well-structured, moving from general purpose to specific usage details. No fluff or redundancy, though it could be slightly more detailed without losing conciseness.

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

Completeness3/5

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

Given the tool has 4 optional params and an output schema, the description covers the main modes but leaves gaps: it does not address the interaction between section and query (mutually exclusive or combinable), the effect of force, or the output format (though schema exists). It is adequate for basic use but not fully complete.

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 0%, so the description must compensate. It explains section, query, and channel, giving concrete meaning (e.g., 'stable (latest release) or master'), but it does not describe the force parameter at all. The coverage is partial—3 out of 4 params—so it adds value but is incomplete.

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 tool fetches the official Zig Language Reference and specifies two modes (section retrieval and query search). It uses a specific verb and resource, but does not explicitly distinguish it from sibling tools like zig_search or zig_std, though the purpose is evident.

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

Usage Guidelines3/5

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

The description provides context for usage—it's the language reference fetcher—and explains the two modes, but it does not explicitly state when to use this tool versus alternatives or when not to use it. No exclusions or alternative guidance is given, so usage is implied rather than explicit.

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

zig_stdA

Standard-library docs from the EXACT released source of the channel.

symbol='std.fs.Dir.openFile' walks real re-exports and returns the /// docs plus the declaration text from that release. query= searches std doc comments. Prefer exact symbols; use query to discover names.

ParametersJSON Schema
NameRequiredDescriptionDefault
forceNo
queryNo
symbolNo
channelNostable

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior4/5

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

With no annotations provided, the description carries the burden. It honestly discloses how it works: walking real re-exports and returning doc comments plus declaration text from the exact release. This gives the agent a clear model of behavior and scope. It does not mention side effects, but as a lookup tool, that is expected. No contradictions with annotations (none exist).

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 concise and well-structured: the first sentence states purpose, the second explains the two modes, and the third gives a preference hint. Every sentence earns its place, and there is no verbose repetition or fluff.

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

Completeness4/5

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

For a documentation lookup tool, the description covers the core behavior and most parameters. The output schema exists, so return values need not be described. The main missing piece is the 'force' parameter's effect, which is a notable hole given the tool's simplicity. Overall, it is reasonably complete but not fully exhaustive.

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 0%, so the description must explain parameters. It explains symbol and query with concrete examples, and channel is implied in the first sentence. However, the 'force' parameter is completely unexplained. With four parameters, leaving one entirely undefined is a notable gap, though the primary modes are well covered.

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

Purpose5/5

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

The description clearly states it provides standard-library docs from a specific channel's released source. It distinguishes itself from siblings like zig_langref and zig_changelog by specifying the resource (standard library) and the operation (returns /// docs and declaration text). The two modes (symbol lookup and query search) are explicitly described.

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

Usage Guidelines3/5

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

It provides guidance on when to use symbol vs query ('Prefer exact symbols; use query to discover names'), which helps within the tool. However, it does not explicitly mention alternatives or when not to use this tool (e.g., versus zig_search or zig_langref). The guidance is implied by the tool's focus on std docs, but it lacks explicit exclusion or alternative routing.

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

zig_updateA

Upgrade the LOCAL zig toolchain to the latest release, safely.

dry_run=True (default): print the exact plan, change nothing. confirm=True AND dry_run=False: apply it (brew upgrade or official tarball). Never pass confirm=True without the user asking for the update.

ParametersJSON Schema
NameRequiredDescriptionDefault
channelNostable
confirmNo
dry_runNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.4/5.0
Behavior5/5

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

With no annotations to rely on, the description takes full responsibility for disclosing behavior. It states that dry_run changes nothing, that confirm=True combined with dry_run=False applies the upgrade, and warns about the danger of confirm=True without user consent. This is unusually clear for a mutation tool; it also implies a side effect (modifying the local toolchain) transparently.

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 compact and well-structured: one sentence states the purpose, the next two explain the two modes with their preconditions, and a final imperative warns about misuse. No filler or redundant information; each sentence earns its place.

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

Completeness3/5

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

While the description covers the two critical operational aspects (dry-run and confirm), it omits the channel parameter entirely and does not mention what the output schema contains (e.g., what a successful upgrade returns). For a tool that mutates the local environment, the missing channel documentation is a real gap. The safety warning is strong, but the parameter coverage is incomplete, leaving the agent to guess about channel.

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

Parameters2/5

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

The description competently explains dry_run and confirm, their defaults, and their interaction. However, the channel parameter is completely ignored. The schema provides no descriptions (0% coverage) and no enums, so the agent has no idea what values channel accepts or how it affects the upgrade (e.g., does 'stable' vs 'master' change the install method or version?). This is a significant gap for a parameter that likely affects the outcome.

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

Purpose5/5

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

The description clearly states a specific action ('upgrade the LOCAL zig toolchain') and distinguishes it from siblings like zig_version_status and zig_changelog which are about checking status or docs. It even explains the two modes (dry_run and apply) and which one is safe by default, leaving no ambiguity about what the tool accomplishes.

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

Usage Guidelines5/5

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

Provides explicit when-to-use and when-not-to-use guidance: dry_run is the default, confirm should never be passed without the user explicitly requesting the update. This tells the agent exactly when to apply vs. just preview, and the warning about confirm covers safety. The mention of 'brew upgrade or official tarball' gives practical method context.

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

zig_version_statusA

Compare local zig version with the latest upstream release.

Returns local version/path, latest stable, master, up_to_date flag and, when behind, a suggested next step. Call this before version-sensitive answers and whenever Zig code misbehaves in ways a newer compiler fixes.

ParametersJSON Schema
NameRequiredDescriptionDefault
forceNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries full responsibility for behavioral disclosure. It describes the return values and the underlying comparison action, and implicitly implies a read-only operation (no mutation language). However, it does not explicitly state side effects, network requirements, or error behavior, which for a status tool could be expected. It adds value beyond the name but leaves some gaps.

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 two sentences, front-loading the core purpose and then detailing the output and usage context. Every sentence earns its place with no redundant words, and the structure is easy to parse.

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

Completeness3/5

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

The tool is simple (one optional boolean parameter) and has an output schema, so the description needn't explain return structure. However, the lack of any explanation for the 'force' parameter and no mention of prerequisites (e.g., network access or presence of ZIG) leaves gaps. The description covers the main use case but not all context needed for safe and correct invocation.

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

Parameters2/5

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

The schema describes a single boolean parameter 'force' with a default but no description, and schema coverage is 0%. The description does not mention this parameter at all, leaving the agent to guess what 'force' does (e.g., bypass cache, force network fetch). Since there is zero coverage and no explanation, the description fails to provide needed semantics for this parameter.

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

Purpose5/5

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

The description uses the specific verb 'Compare' with a clear resource ('local `zig version` with the latest upstream release') and enumerates exactly what is returned. It also differentiates from siblings like zig_update by focusing on status rather than modification, so an agent can select it without ambiguity.

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

Usage Guidelines4/5

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

The description explicitly states when to use the tool: 'before version-sensitive answers' and 'whenever Zig code misbehaves in ways a newer compiler fixes.' It does not mention when not to use it or point to alternatives, which would make it a 5, but the guidance is clear and actionable.

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.

  1. 7 tool updatesv0.1.0
    • First observedperf_guidance
    • First observedzig_changelog
    • First observedzig_langref
    • First observedzig_search
    • First observedzig_std
    • First observedzig_update
    • First observedzig_version_status

TDQS

A3.7/5.0

Scored across 7 tools

Disambiguation5/5

Each tool targets a distinct purpose: version checking, updating, language reference, standard library docs, changelog, performance guidance, and a unified search that complements the others. No two tools appear to do the same thing, and descriptions clarify boundaries.

Naming Consistency4/5

Most tools follow a 'zig_' prefix, but the second element varies in style (noun, verb_noun, abbreviation). 'perf_guidance' breaks the prefix pattern. Still, names are short, descriptive, and predictable enough for an agent to infer purpose.

Tool Count5/5

Seven tools is well-scoped for a documentation and toolchain server. Each tool earns its place, covering version checks, updates, references, and search, without bloat or missing essentials.

Completeness5/5

The surface covers the core documentation lifecycle: version status, update, language reference, std docs, changelog, performance guidance, and a cross-cutting search. There are no obvious gaps for the stated purpose of providing Zig documentation and version management.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Provides Zig language tooling and code analysis, enhancing AI capabilities with Zig-specific functions like code optimization, compute unit estimation, code generation, and recommendations for best practices.
    7
    51
    MIT
  • A
    license
    Not graded
    quality
    C
    maintenance
    Enables AI-powered Zig programming assistance through code generation, debugging, and documentation explanation. Uses local LLM models to provide idiomatic Zig code creation and analysis capabilities.
    34 npm
    10
    Do What The F*ck You Want To Public
  • F
    license
    Not graded
    quality
    C
    maintenance
    MCP server for Zig that connects AI coding assistants to ZLS (Zig Language Server) via LSP. Provides 16 tools for code intelligence (hover, go-to-definition, references, completions, diagnostics, rename, format) and build/test operations.
    7
    -
  • A
    license
    A
    quality
    C
    maintenance
    A high-performance MCP server providing up-to-date documentation for Go, npm, Python, Rust, Docker, Kubernetes, Terraform, and more — fetched from official sources, not training data.
    18
    3
    MIT