Nyuchi Docs
概览
作者提供的说明(英文原文)
Search, read, and ask the Nyuchi docs (docs.nyuchi.com); send feedback or raise issues.
PopNx MCP 的三大支柱
这三项永远不会合并成一个分数:意见、测量和人气是不同的东西。
- 用户评价i暂无评价评价功能将在后续阶段与账户功能一起开放
- 我们的基础检查i1 项中通过 1 项依据公开信息检查;尚未扫描代码
- 使用情况i非常新↓ 41/周 · ★ –
它能帮你做什么
我们还没有为它写通俗的介绍。下面是我们从注册中心读取到的事实。
- 连接方式: 电脑或云端
- 传输方式: stdio, Streamable HTTP
- 分类: 搜索与 AI 记忆
安装
选择你使用的 AI 应用,然后复制设置。
安装之前
- 基础检查:1 项中通过 1 项
- 在作者的服务器上运行:你向它提出的内容会经过他们的服务器。
- 注册中心没有列出需要填写的密钥。
你需要
你用的是哪个应用?
在上方选择你的应用。我们会记住它,下次按钮会显示“安装到 …”。
适用于网页版、桌面版和手机版 Claude:
- 打开 Settings → Connectors
- 点击 Add custom connector
- 粘贴下面的地址,然后点击 Add
- 如果要求登录,请登录作者的服务
https://docs.nyuchi.com/mcp或者在你的电脑上运行
打开 Claude Desktop → Settings → Developer → Edit Config,把下面的内容粘贴到 claude_desktop_config.json
{
"mcpServers": {
"nyuchi-docs": {
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}在终端中运行这条命令
claude mcp add --transport http nyuchi-docs https://docs.nyuchi.com/mcp或者在你的电脑上运行
claude mcp add nyuchi-docs -- npx -y nyuchi-docs-mcp或者自己复制设置
粘贴到项目中的 .cursor/mcp.json,或 ~/.cursor/mcp.json
{
"mcpServers": {
"nyuchi-docs": {
"url": "https://docs.nyuchi.com/mcp"
}
}
}或者在你的电脑上运行
或者自己复制设置
粘贴到项目中的 .cursor/mcp.json,或 ~/.cursor/mcp.json
{
"mcpServers": {
"nyuchi-docs": {
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}浏览器会先询问是否打开应用,然后应用会显示设置并请你确认。密钥的值会留空,由你自己填写。
或者自己复制设置
粘贴到项目中的 .vscode/mcp.json
{
"servers": {
"nyuchi-docs": {
"type": "http",
"url": "https://docs.nyuchi.com/mcp"
}
}
}或者在你的电脑上运行
或者自己复制设置
粘贴到项目中的 .vscode/mcp.json
{
"servers": {
"nyuchi-docs": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"nyuchi-docs-mcp"
]
}
}
}浏览器会先询问是否打开应用,然后应用会显示设置并请你确认。密钥的值会留空,由你自己填写。
ChatGPT 只能连接互联网上的服务器:
- 打开网页版 ChatGPT → Settings → Connectors (Apps)
- 点击 Create 或 Add(部分套餐需要先在 Advanced 中开启 Developer mode)
- 粘贴下面的地址,起个名字,然后保存
- 如果要求登录,请登录作者的服务
https://docs.nyuchi.com/mcp菜单名称可能因套餐和版本不同而略有差异。
你的选择通过 Cookie 保存在这台设备上,无需账户。
这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
它能做什么
我们还没有读取这个服务器的工具列表;我们会轮流检查各个端点。
基础检查i
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月10日
- ✓ 通过
作者与仓库一致
注册名称已通过 GitHub 账户 nyuchi 验证,该账户拥有此仓库
- … 尚未检查
仍在维护
我们还没有从 GitHub 读取这个仓库
- … 尚未检查
有许可证
我们还没有从 GitHub 读取这个仓库
- … 尚未检查
端点有响应
尚未检查;我们会轮流检查各个端点
- … 尚未检查
使用 OAuth 登录
尚未检查;我们会轮流检查各个端点
- … 尚未检查
工具描述中没有隐藏指令
尚未检查;我们会在检查端点时读取工具列表
与“搜索与 AI 记忆”中的其他服务器比较i
- 星标数多于此分类中其他 5814 个服务器的 0%
- 发布到注册中心的时间比此分类中其他 5814 个服务器的 23% 更新
- 基础检查结果等于或优于此分类中其他 5814 个服务器的 100%
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
常见问题
Nyuchi Docs 安全吗?
它在 1 项适用的基础检查中通过了 1 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
它需要哪些密钥或代码?
注册中心没有列出必需的密钥,不过有些服务器会在首次使用时要求你登录。
它在我的电脑上运行还是在云端?
两种方式都可以:安装在你的电脑上,或者连接云端版本。
它还在维护吗?
GitHub 仓库最后更新于–,最新版本(0.1.0)于4个月前进入注册中心。
哪些应用可以使用它?
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。它通过 URL 连接,所以接受远程 MCP 服务器的应用也可以使用,例如开启开发者模式的 ChatGPT。
有什么可以替代它?
同一分类中有:Context7, Codebase Memory, Exa
替代选择
同一分类中其他作者的服务器,按星标数排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
Codebase Memory
Codebase knowledge graph for AI agents — 162 languages, sub-ms queries, 99% fewer tokens.
Exa
Connect AI agents to Exa for web search, content fetching, and multi-step research.
作者的 README
打开 README
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
Nyuchi 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.org
returns
{"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 at
platform.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) — root
site/, 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` — root
shamwari-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` — root
nyuchi-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, by
staging-version.yml. - A release to `main` is the next minor above the highest tag. The PR that releases sets
versioninnyuchi-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.