Wikidown.Mcp
0.7.0
dotnet tool install --global Wikidown.Mcp --version 0.7.0
dotnet new tool-manifest
dotnet tool install --local Wikidown.Mcp --version 0.7.0
#tool dotnet:?package=Wikidown.Mcp&version=0.7.0
nuke :add-package Wikidown.Mcp --version 0.7.0
Wikidown
A structured markdown wiki that lives in /docs of any code repo — plain
pages, folder-based hierarchy, and .order navigation files. The same format
Azure DevOps wikis use, readable by humans on disk, editable by AI agents
through MCP, and browsable in Visual Studio or the web editor.
Site: wikidown.org · Editor: wikidown.app · Docs: /docs (a Wikidown wiki, naturally)
Quick start: add Wikidown to your repo
If you have .NET installed, install the CLI as a global tool:
dotnet tool install -g Wikidown.Cli
If not, these scripts install a self-contained binary — no .NET required:
curl -fsSL https://wikidown.org/install.sh | sh
irm https://wikidown.org/install.ps1 | iex
Then set your repo up end to end:
wikidown init
Run from your repo root, wikidown init:
- seeds
docs/Home.mdif the wiki is empty; - drops in agent configs so AI assistants edit the wiki through proper
tools instead of raw file writes:
- Claude Code:
.mcp.json, awikidownskill, and awikidown-editorsubagent, plus aCLAUDE.mdsection; - GitHub Copilot:
.vscode/mcp.json,.github/copilot-instructions.md, an agent, a chat mode, and a skill.
- Claude Code:
Use --agents claude|copilot|all|none to pick, --force to overwrite, and
--root <folder> if your wiki isn't in docs/.
Publish with GitHub Pages
wikidown pages
Scaffolds a Jekyll site into the wiki folder — _config.yml tuned for the
Wikidown format, a starter theme with a left-nav tree driven by your
.order files, and an index.html redirect to Home — then push and set
Settings → Pages → Source: main, /docs. The nav data
(_data/navigation.yml) is regenerated automatically by the CLI and MCP
server on every change.
For any other host — GitLab Pages, Azure Static Web Apps, Netlify, a file share — or to preview locally, render the same theme in .NET instead; no Jekyll or Ruby involved:
wikidown export-html --output public
Details for both in
/docs/Getting-Started/Publishing-to-GitHub-Pages.
Give agents the MCP server
The configs above launch the Wikidown MCP server, so install it once globally:
dotnet tool install -g Wikidown.Mcp
The MCP server needs the .NET SDK/runtime (it has no self-contained binary
yet). On machines without .NET that used the install-script binary, agents
fall back to the equivalent wikidown CLI commands per the shared skill.
That's it — Claude Code / Copilot in that repo now have wiki_list,
wiki_read, wiki_write, wiki_new, wiki_move, wiki_delete,
wiki_reorder, wiki_search, and wiki_walk tools that keep .order files
consistent. Manual configs for other hosts are in samples/mcp/.
See the wiki in Visual Studio
Install Wikidown Wiki Project from the
Visual Studio Marketplace
(VS 2022+), then right-click your solution → Add → New Project → Wikidown
Wiki. Your wiki appears in Solution Explorer the way Azure DevOps renders
it — page titles, .order-driven sorting, expandable subpage nodes — with
context-menu commands to add, reorder, and delete pages. The project never
participates in the build. Details: src/Wikidown.Vs/
and the wiki page.
Edit in the browser
Open wikidown.app, connect your GitHub, GitLab, or Azure DevOps repo, and edit pages directly — commits go through the provider's REST API, no backend involved.
Everyday CLI usage
wikidown list --path / # pages at the wiki root, in nav order
wikidown new --path /Guides/Getting-Started # create a page (updates .order)
wikidown read --path /Guides/Getting-Started # print a page
wikidown search --query "release notes" # full-text search
wikidown move --from /Old-Name --to /New-Name # rename/move, keeps .order consistent
wikidown reorder --folder / --names Home,Guides # set explicit nav order
wikidown delete --path /Scratch --recursive # remove a page (and its subpages)
All commands accept --root <folder> (default docs).
What's in this repo
| Piece | What it is |
|---|---|
src/Wikidown.Core |
Library: page model, .order handling, repo, search (NuGet) |
src/Wikidown.Cli |
wikidown dotnet tool (NuGet) |
src/Wikidown.Mcp |
wikidown-mcp stdio MCP server (NuGet) |
src/Wikidown.Vs |
Visual Studio extension (Marketplace) |
src/Wikidown.Web |
Blazor WASM editor PWA (wikidown.app) |
src/Wikidown.Html |
Starter theme + static HTML export (wikidown export-html, Markdig + Fluid) |
agents/ |
Drop-in agent configs (installed by wikidown init) |
samples/mcp/ |
Example MCP configs for various hosts |
docs/ |
This repo's own wiki — also the source of wikidown.org, published with wikidown export-html (dogfood twice over) |
Format in one breath
- Page file on disk:
My-Page.md; rendered title:My Page. - Subpages: a folder alongside the page file with the same base name
(
Architecture.md+Architecture/). - Ordering:
.orderfile per folder lists page base-names, one per line; unlisted pages follow alphabetically. - Links use title paths:
[Release Notes](/Getting-Started/Release-Notes).
Full spec: docs/Getting-Started/Format.md.
Status
Work in progress — see PLAN.md for chunk-by-chunk progress.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.