Позволяет AI-клиенту искать, читать и задавать вопросы по инженерной и продуктовой документации Nyuchi.
Также известен как nyuchi/nyuchi-docs, nyuchi-docs-mcp
- Звёзды
- 0
- Инструменты
- —
- Загрузки, 30 дней
- —
- Последняя версия
- 0.1.0
- Последний коммит
- 14 нояб. 2026 г.
- Лицензия
- —
Что такое nyuchi-docs MCP?
Позволяет AI-клиенту искать, читать и задавать вопросы по инженерной и продуктовой документации Nyuchi.
Сводка сгенерирована из README проекта
О nyuchi-docs MCP server
Разработчики, которым нужны технические рекомендации по платформе Nyuchi или инструментам Mzizi, могут использовать этот сервер для прямого запроса инженерной и продуктовой документации через AI-клиент. Он предоставляет доступ к широкому спектру информации, включая детали API для v1 gateway, аутентификацию WorkOS, аналитические панели и паттерны развертывания для Cloudflare, Vercel и Supabase.
Сервер работает через Cloudflare Worker, размещенный на определенном эндпоинте, но также включает пакет stdio bridge для клиентов, которые не могут взаимодействовать через streamable HTTP. Это обеспечивает возможность как удаленной, так и локальной интеграции в зависимости от конфигурации клиента. Пользователи могут задавать вопросы по конкретным руководствам по продуктам, таким как Mukoko Kweli или Mukoko Weather, или запрашивать информацию о внутренних инженерных стандартах, например, о правилах оформления PR или правилах именования репозиториев.
Что вы можете с ним делать
- 1Запросы спецификаций APIПопросите AI объяснить, как использовать v1 gateway или управлять API-ключами через консоль.
- 2Изучение паттернов развертыванияЗапрашивайте инструкции по развертыванию приложений с использованием конкретных облачных провайдеров.
- 3Изучение инженерных стандартовЗапрашивайте официальные правила оформления pull requests и сообщений коммитов, принятые в Nyuchi.
Взято из README проекта. Каждый вариант использования проверен на соответствие цитате из него.
Как установить nyuchi-docs MCP
Форматы проверены 10 ноя 2026Добавить в CursorДобавить в GooseУстановка nyuchi-docs MCP в Claude Code
$ claude mcp add nyuchi-docs -- npx -y nyuchi-docs-mcpУстановка nyuchi-docs MCP в Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"nyuchi-docs": {
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}Установка nyuchi-docs MCP в VS Code
.vscode/mcp.json
{
"servers": {
"nyuchi-docs": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}Установка nyuchi-docs MCP в VS Code CLI
$ code --add-mcp '{"name":"nyuchi-docs","type":"stdio","command":"npx","args":["-y","nyuchi-docs-mcp"]}'Установка nyuchi-docs MCP в Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"nyuchi-docs": {
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}Установка nyuchi-docs MCP в Codex
$ codex mcp add nyuchi-docs -- npx -y nyuchi-docs-mcpУстановка nyuchi-docs MCP в Codex config.toml
~/.codex/config.toml
[mcp_servers.nyuchi-docs] command = "npx" args = ["-y", "nyuchi-docs-mcp"]
Установка nyuchi-docs MCP в Gemini CLI
$ gemini mcp add -s user nyuchi-docs npx -- -y nyuchi-docs-mcpУстановка nyuchi-docs MCP в Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"nyuchi-docs": {
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}Автоматические проверки
Запущено 14 нояб. 2026 г.Полный отчёт →Прошло наши автоматизированные проверки. Это не аудит безопасности: изучите код и предоставьте серверу минимально необходимый доступ. Как работают проверки · Что исправить, чтобы получить больше баллов
- Связанный и доступный исходный репозиторийnyuchi/nyuchi-docs is public and reachablegithub.com/nyuchi/nyuchi-docs ↗Пройдено
- Пакет указывает этот репозиторий как источникnyuchi-docs-mcp names nyuchi/nyuchi-docs as sourcenpmjs.com/package/nyuchi-docs-mcp ↗Пройдено
- Происхождение сборки (аттестация Sigstore)No build attestation published for this releaseНе проверялось
- Open source лицензия (OSI)No licenseПроблема
- Коммит или релиз за последний годLast commit or release 2026-11-14github.com/nyuchi/nyuchi-docs ↗Пройдено
- OpenSSF ScorecardНе проверялось
- Имя пакета не похоже на популярный пакетNo popular package one edit away from nyuchi-docs-mcpПройдено
- Нет критических предупреждений в пакете или его зависимостях1 resolved dependencies checked; no critical advisoryosv.dev ↗Пройдено
- Нет скрытых инструкций для модели0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersПройдено
- Деструктивные инструменты помеченыНе проверялось
- Удалённая конечная точка отвечает на рукопожатие MCPinitialize answered with protocol 2025-06-18 in 101 msПройдено
README
Открыть на GitHubNyuchi Docs
Nyuchi engineering documentation — how things are done at Nyuchi, and how to use the Mzizi tools from a Nyuchi project.
Live: docs.nyuchi.com | Product docs:
docs.bundu.org | MCP: docs.nyuchi.com/mcp
Packages
A pnpm workspace of six packages.
| Package | Path | What it does |
|---|---|---|
site |
site/ |
The Astro + Starlight docs site itself. Ships as a Cloudflare Worker with Static Assets. |
@nyuchi/nyuchi-docs-search |
nyuchi-docs-search/ |
cmdk-style search modal + Ask-AI tab for Starlight sites. Not yet published to npm. |
shamwari-docs-ai |
shamwari-docs-ai/ |
Cloudflare Worker — the Ask-AI chat proxy (SSE). |
nyuchi-docs-mcp-worker |
nyuchi-docs-mcp-worker/ |
Cloudflare Worker nyuchi-docs-mcp — the docs MCP server at docs.nyuchi.com/mcp. |
@nyuchi/nyuchi-docs-mcp |
nyuchi-docs-mcp/ |
The stdio bridge to that hosted endpoint, for clients that cannot speak Streamable HTTP. |
@nyuchi/nyuchi-docs-skills |
nyuchi-docs-skills/ |
The public agent skill for docs.nyuchi.com. The repo's authoring skills are internal and deliberately not shipped. |
Companion site
bundu-labs/bundu-docs covers the
Bundu Foundation's outward-facing projects — the Mzizi product, the Ubuntu
doctrine, and the Bundu brand system. It is an internal-visibility repository,
so that link resolves only for org members. It consumes
@nyuchi/nyuchi-docs-search and points at the nyuchi-docs-mcp worker.
@nyuchi/nyuchi-docs-searchis not on npm —registry.npmjs.orgreturns{"error":"Not found"}for it (checked 2026-09-12). Until it is published,bundu-docscannot install it from the registry.
Sections (site/src/content/docs/)
platform/— the product guide for the Nyuchi platform.api/— API Docs: the/v1gateway, WorkOS authentication, console-managed API keys, security, and the product namespaces.analytics/— dashboards, reports, and connecting data sources.kweli/— Mukoko Kweli product guides: verification, cross-app how-to, open data, data quality, design system.mukoko-weather/— Mukoko Weather user guide and stations.integrations/— connectors, webhooks, the docs MCP server, and the Mukoko Events MCP server.identity/— WorkOS,accounts.mukoko.com(the AuthKit issuer), SSO, JWTs.console/— the Nyuchi Console atplatform.nyuchi.com.tools/— the cross-repo tools directory: every skill, CLI, and MCP server across the Nyuchi and Bundu repos.mzizi-tools/—mzizi-mcp,mzizi-cli,mzizi-skills, the DNA double-helix architecture, registry health, and the A2A design.deployment/— Cloudflare, Vercel, and Supabase deployment patterns.conventions/— PR doctrine, commit doctrine, repo-naming rules.
Develop
pnpm install
pnpm dev # site only
pnpm -r build # all packages
pnpm -r test # all packages
Site dev server: http://localhost:4321. Content lives in
site/src/content/docs/; the sidebar is configured in site/astro.config.mjs.
Search + Ask AI
The search modal opens with ⌘K / Ctrl+K. The Ask AI tab streams
answers from shamwari-docs-ai (Cloudflare Worker) with retrieval-grounded
citations. To enable it locally, copy site/.env.example to site/.env:
cp site/.env.example site/.env
# .env:
# PUBLIC_SHAMWARI_AI_URL=https://shamwari-docs-ai.nyuchi.workers.dev
Deploy
Both workers in this repo deploy via Cloudflare Workers Builds — the
Cloudflare GitHub App
is connected to nyuchi/nyuchi-docs with one trigger per worker (root
directory points at the worker package). No GitHub Actions deploy workflow,
no CLOUDFLARE_API_TOKEN repo secret.
nyuchi-docs(site) — rootsite/, ships as a Cloudflare Worker with Workers Static Assets. Live athttps://nyuchi-docs.nyuchi.workers.dev, and the cutover is done:docs.nyuchi.comnow serves this Worker. Both hosts return the same Astro 7.2.9 / Starlight 0.41.10 page (checked 2026-09-12); there is no Mintlify-on-Vercel deployment behind the apex any more.shamwari-docs-ai— rootshamwari-docs-ai/, thin proxy in front of Cloudflare AI Search. Live athttps://shamwari-docs-ai.nyuchi.workers.dev, which serves exactly two routes:GET /healthandPOST /chat. Its root returns404, correctly. Seeshamwari-docs-ai/README.mdfor the per-corpus AI Search instance setup (managed via REST API).nyuchi-docs-mcp— rootnyuchi-docs-mcp-worker/, the docs MCP server. Live athttps://nyuchi-docs-mcp.nyuchi.workers.devand routed fromdocs.nyuchi.com/mcp*. Needs its own Workers Builds trigger (root directorynyuchi-docs-mcp-worker/).
Well-known and machine-readable endpoints
docs.nyuchi.com serves these outside the docs tree. Most are static files in
site/public/; security.txt is generated per request by the site worker.
| Path | Served from | What it is |
|---|---|---|
/robots.txt |
site/public/robots.txt |
Crawl policy + sitemap pointer. Everything here is meant to be indexed. |
/llms.txt |
site/public/llms.txt |
Machine-readable site index for LLMs. |
/AUTH.md |
site/public/AUTH.md |
Agent-facing WorkOS auth reference, synced from nyuchi/api-gateway. |
/.well-known/mcp/server-card.json |
site/public/.well-known/mcp/ |
MCP server card for the nyuchi-docs-mcp worker at /mcp. |
/.well-known/security.txt |
site/src/worker/security-txt.ts |
RFC 9116 disclosure contact — generated per request, not a static file. |
security.txt is dynamic because RFC 9116 makes Expires mandatory and caps
it under one year, so a checked-in file silently becomes non-compliant as it
ages. site/wrangler.toml sets run_worker_first = true, so every request
already passes through site/src/worker/gate.ts; it answers this path before
the gate check and before the asset router, deriving Expires from the
request time (180 days out). Same approach as mukoko-dev/mukoko-events (formerly
nhimbe) and mukoko-dev/kweli.
Why pnpm workspace
The search package (nyuchi-docs-search) is consumed by both
nyuchi-docs (this repo, via workspace:*) and bundu-docs (separate repo,
via the npm registry). Keeping it in the same workspace as the docs site
means local changes to the search UI are picked up instantly during pnpm dev,
while the published package is a single pnpm publish away.
Commands
| Command | Description |
|---|---|
pnpm dev |
The docs site on :4321 |
pnpm build |
Build the site |
pnpm build:all |
Build every workspace package |
pnpm test |
Every package's tests |
pnpm lint |
Every package's linter |
pnpm check |
Every package's type/content check |
pnpm skills:validate |
Validate the shipped agent skills |
pnpm deploy:worker |
Deploy shamwari-docs-ai |
pnpm deploy:mcp |
Deploy nyuchi-docs-mcp-worker |
pnpm ingest |
Re-ingest the corpus into Cloudflare AI Search |
Never run
prettier --writeon an.mdxfile. Prettier 3.9.x rewrites{/* … */}to{/_ … _/}and produces invalid MDX..mdis safe.
Ecosystem
- docs.bundu.org — Bundu Foundation product docs
- mzizi.dev — the Mzizi design system, an open-architecture project of the Bundu Foundation, operated and developed by Nyuchi
- api.nyuchi.com — the
/v1gateway these docs describe
Versioning
Releases follow the org versioning policy (nyuchi/.github#80). The branch decides the bump, and there are no version labels:
- A merge into
staging(the live beta) is tagged as the next patch automatically, bystaging-version.yml. - A release to
mainis the next minor above the highest tag. The PR that releases setsversioninnyuchi-docs-mcp/package.jsonto it. CI refuses any other version and names the right one. - A major is only ever made by hand: the owner runs the release
workflow from the Actions tab with
bump: major. - Each segment holds 0–999. Patch 999 rolls into the next minor; minor 999 stops and asks for a manual major.
Versions released before 2026-10-04 are not renumbered.
Licence
This repository is public but carries no LICENSE file, so no licence is
granted over it as a whole: all rights reserved. © Nyuchi Africa (PVT) Ltd.
The @nyuchi/nyuchi-docs-search package declares MIT in its own
package.json; if that is the intent for the package, the repository needs
a LICENSE to back it.
Вопросы о nyuchi-docs MCP
Как добавить nyuchi-docs MCP в Claude Code?
Выполните claude mcp add nyuchi-docs -- npx -y nyuchi-docs-mcp в терминале. Добавьте --scope user, чтобы сервер был доступен во всех проектах.
Как добавить nyuchi-docs MCP в Cursor?
Откройте ~/.cursor/mcp.json и добавьте сервер в mcpServers, используя конфигурацию Cursor из раздела установки выше.