QDG KB updatewiki User Guide

Purpose

The updatewiki skill lets a developer ask Codex or Claude Code to create, retrieve, and maintain project documentation in QDG KB. Pages are stored as Markdown in the Odin qdgwiki database. Every publication creates an immutable version with a change description, author, and optional task or commit reference.

Installing the skill and connecting the MCP server are separate steps:

1. The skill teaches the client how to interpret updatewiki requests.
2. The QDG KB MCP server supplies the database tools used by the skill.

Both must be available. A visible skill without the MCP tools cannot update the knowledge base.

The developer is leveraging AI editorial judgment

updatewiki is not a file append or database-copy command. Codex or Claude reads the current KB page, the new information, and relevant project evidence, then decides what is important enough to preserve, where it belongs, and how it should be expressed. The AI produces the complete revised Markdown page. The MCP server performs deterministic validation, concurrency checking, and immutable version storage; it does not decide what the documentation should say.

How an update is produced

For a request such as updatewiki changelog with release.md:

1. Codex or Claude resolves the current project and page.
2. It retrieves the current Markdown and immutable version number through MCP.
3. It reads release.md completely and inspects other relevant evidence when available.
4. It uses AI judgment to identify durable changes, omit transient noise, preserve correct existing content, and place the new material in the appropriate section.
5. It creates the complete revised Markdown page rather than merely appending the file.
6. It sends that complete page and the expected current version to kb_update_page.
7. The MCP validates and saves the result as a new immutable version. A stale version is rejected so the AI can reread and merge concurrent work.

Prerequisites

• Windows PowerShell.
• Python 3.11 or newer, available through the py launcher.
• Access to the repository checkout.
• Access to the Odin database and the qdgwiki schema.
• A database configuration file such as C:\Users\Work\projects_config\db.json.
• Codex, Claude Code, or both.

Do not copy database credentials into the repository or a checked-in MCP configuration.

Prepare QDG KB

Open PowerShell and run:

Set-Location 'D:\Github\KN Docs'
powershell -ExecutionPolicy Bypass -File scripts\bootstrap.ps1
powershell -ExecutionPolicy Bypass -File scripts\migrate.ps1 status
powershell -ExecutionPolicy Bypass -File scripts\migrate.ps1 apply
powershell -ExecutionPolicy Bypass -File scripts\verify.ps1

If the database configuration is elsewhere, set it before running migrations or starting the client:

$env:QDGKB_DB_JSON = 'D:\secure\db.json'

Install for Codex

1. Install the skill

For every repository used by your Windows account:

Set-Location 'D:\Github\KN Docs'
powershell -ExecutionPolicy Bypass -File scripts\install-skill.ps1 -Target codex

For repository scope only:

powershell -ExecutionPolicy Bypass -File scripts\install-skill.ps1 -Target codex -Scope repository

2. Configure the MCP server

Add a server entry configured to run python -m qdgkb.

[mcp_servers.qdgkb]
command = "D:\\Github\\KN Docs\\.venv\\Scripts\\python.exe"
args = ["-m", "qdgkb"]
cwd = "D:\\Github\\KN Docs"
startup_timeout_sec = 20

If needed, set QDGKB_DB_JSON in the environment without exposing credentials:

[mcp_servers.qdgkb.env]
QDGKB_DB_JSON = "D:\\secure\\db.json"

Install for Claude Code

1. Install the skill

Set-Location 'D:\Github\KN Docs'
powershell -ExecutionPolicy Bypass -File scripts\install-skill.ps1 -Target claude

2. Configure the MCP server

claude mcp add qdgkb --scope user --env QDGKB_DB_JSON='C:\Users\Work\projects_config\db.json' -- 'D:\Github\KN Docs\.venv\Scripts\python.exe' -m qdgkb

Then confirm:

claude mcp list
claude mcp get qdgkb

Common requests

updatewiki create project documentation
updatewiki changelog with release.md
updatewiki faq with questions.md
updatewiki user guide with docs\user-guide.md
updatewiki quick reference with docs\quick-reference.md
findwiki how is QDG KB connected to QWebHub?

Page types

• overview — purpose, scope, architecture, and starting points
• changelog — delivered changes and fixes
• workflow — repeatable procedures
• faq — recurring questions and durable answers
• bugs — defects, workarounds, and resolutions
• notes — durable findings not yet in canonical pages
• user-guide — detailed instructions for learning or operating the project
• quick-reference — compact commands and examples
• general — named topic pages

Safety

• Never publish credentials, tokens, private keys, or sensitive connection details.
• Preserve historical context unless it is obsolete.
• If versions conflict, reread and merge before retrying.
• Restoring an old version creates a new version rather than rewriting history.