Nyuchi Docs

io.github.nyuchiPublished by GitHub account nyuchiv0.1.0Updated Oct 24, 2026

Search, read, and ask the Nyuchi docs (docs.nyuchi.com); send feedback or raise issues.

The publisher's own server: Concierge

VerifiedStreamable HTTPWeb executableKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Searches, reads and answers questions from the Nyuchi engineering docs site, and lets an assistant send feedback or file documentation issues.

What you can do
  • Search the Nyuchi docs by keyword or semantics and get matching pages with titles, URLs and snippets
  • Ask a question and get a synthesized answer grounded in the docs, with source citations
  • Fetch a docs page by path or full URL and return its readable text
  • Send feedback about the documentation, such as corrections, confusing parts or gaps
  • Raise an actionable documentation issue, filed on GitHub when configured or queued for the docs team
When to use it
Useful when working with Nyuchi's platform, API, identity, analytics or deployment documentation and you want the assistant to look things up, answer questions with citations, or report a documentation problem without leaving the chat.
Requirements
Either the hosted Streamable HTTP endpoint at docs.nyuchi.com/mcp, or the npm package nyuchi-docs-mcp run with npx as a stdio bridge for clients that cannot speak Streamable HTTP. No authentication, environment variables or headers are declared. Network access to docs.nyuchi.com is needed.
Before you install
The server is read-only for docs, but submit_feedback and raise_issue send content to the docs team and may create a GitHub issue on the nyuchi/nyuchi-docs repository, so avoid including secrets or private details in feedback. Answers come from a third-party site, so verify citations before relying on them.

Installation

In SourceWeft

  1. Open Nyuchi Docs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/io.github.nyuchi%2Fnyuchi-docs/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "nyuchi-docs": {
      "type": "http",
      "url": "https://docs.nyuchi.com/mcp"
    }
  }
}

README

Nyuchi Docs

Nyuchi engineering documentation — how things are done at Nyuchi, and how to use the Mzizi tools from a Nyuchi project.

[lint] [build] [Astro] [Starlight] [Cloudflare] [pnpm]

Live: docs.nyuchi.com | Product docs: docs.bundu.org | MCP: docs.nyuchi.com/mcp


Packages

A pnpm workspace of six packages.

PackagePathWhat it does
sitesite/The Astro + Starlight docs site itself. Ships as a Cloudflare Worker with Static Assets.
@nyuchi/nyuchi-docs-searchnyuchi-docs-search/cmdk-style search modal + Ask-AI tab for Starlight sites. Not yet published to npm.
shamwari-docs-aishamwari-docs-ai/Cloudflare Worker — the Ask-AI chat proxy (SSE).
nyuchi-docs-mcp-workernyuchi-docs-mcp-worker/Cloudflare Worker nyuchi-docs-mcp — the docs MCP server at docs.nyuchi.com/mcp.
@nyuchi/nyuchi-docs-mcpnyuchi-docs-mcp/The stdio bridge to that hosted endpoint, for clients that cannot speak Streamable HTTP.
@nyuchi/nyuchi-docs-skillsnyuchi-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-search is not on npm — registry.npmjs.org returns {"error":"Not found"} for it (checked 2026-09-12). Until it is published, bundu-docs cannot install it from the registry.

Sections (site/src/content/docs/)

  • platform/ — the product guide for the Nyuchi platform.
  • api/ — API Docs: the /v1 gateway, 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

sh
pnpm installpnpm dev            # site onlypnpm -r build       # all packagespnpm -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:

sh
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 at https://nyuchi-docs.nyuchi.workers.dev, and the cutover is done: docs.nyuchi.com now 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 at https://shamwari-docs-ai.nyuchi.workers.dev, which serves exactly two routes: GET /health and POST /chat. Its root returns 404, correctly. See shamwari-docs-ai/README.md for the per-corpus AI Search instance setup (managed via REST API).
  • nyuchi-docs-mcp — root nyuchi-docs-mcp-worker/, the docs MCP server. Live at https://nyuchi-docs-mcp.nyuchi.workers.dev and routed from docs.nyuchi.com/mcp*. Needs its own Workers Builds trigger (root directory nyuchi-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.

PathServed fromWhat it is
/robots.txtsite/public/robots.txtCrawl policy + sitemap pointer. Everything here is meant to be indexed.
/llms.txtsite/public/llms.txtMachine-readable site index for LLMs.
/AUTH.mdsite/public/AUTH.mdAgent-facing WorkOS auth reference, synced from nyuchi/api-gateway.
/.well-known/mcp/server-card.jsonsite/public/.well-known/mcp/MCP server card for the nyuchi-docs-mcp worker at /mcp.
/.well-known/security.txtsite/src/worker/security-txt.tsRFC 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

CommandDescription
pnpm devThe docs site on :4321
pnpm buildBuild the site
pnpm build:allBuild every workspace package
pnpm testEvery package's tests
pnpm lintEvery package's linter
pnpm checkEvery package's type/content check
pnpm skills:validateValidate the shipped agent skills
pnpm deploy:workerDeploy shamwari-docs-ai
pnpm deploy:mcpDeploy nyuchi-docs-mcp-worker
pnpm ingestRe-ingest the corpus into Cloudflare AI Search

Never run prettier --write on an .mdx file. Prettier 3.9.x rewrites {/* … */} to {/_ … _/} and produces invalid MDX. .md is 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 /v1 gateway 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 version in nyuchi-docs-mcp/package.json to 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.

Source: README.md at commit 9a92961

Tools

5

search_docs

Search the docs

Keyword/semantic search over docs.nyuchi.com. Returns matching pages with titles, URLs and snippets.

Parametersqueryrequiredtop_k

ask_docs

Ask the docs

Ask a question and get a synthesized answer grounded in docs.nyuchi.com, with source citations.

Parametersquestionrequired

read_page

Read a docs page

Fetch a docs.nyuchi.com page and return its readable text content. Accepts a path (e.g. /kweli/verification/) or a full docs.nyuchi.com URL.

Parameterspathrequired

submit_feedback

Submit docs feedback

Send feedback about the documentation — a correction, something confusing, something missing. Stored for the docs team.

Parameterskindpagecontactmessagerequired

raise_issue

Raise a docs issue

Raise an actionable issue against the documentation (wrong instructions, broken example, outdated page). Files a GitHub issue on nyuchi/nyuchi-docs when configured, otherwise queues it for the docs team.

Parametersbodyrequiredpagetitlerequired

Version history

1
  1. v0.1.0LatestSep 16, 2026

Score

90% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

    Declare a license in the repository or the registry entry.

Other Iconic-Expeditions integrations