Rework the install documentation#486
Merged
Merged
Conversation
The install configurations and badges omitted -y, while the bundled plugin and extension manifests already passed it. Aligning them avoids an install-confirmation step for anyone whose npm is configured to require one. Adding -y makes the -- separator necessary in the claude mcp add example, so flag placement is now shown explicitly. Also re-encodes the three one-click badges, which carried a malformed Cursor payload and the superseded VS Code deeplink dialect.
Gemini CLI stopped serving consumer Google AI tiers in June 2026 and Antigravity imports an existing Gemini CLI configuration. Removes the manifest, its release-sync wiring, and the install section.
Adopts a canonical-snippet-plus-table shape: the launch config appears once, clients that differ only by config file path and root key become table rows, and Claude Desktop points at the mcpb bundle rather than a JSON block.
Removes a duplicated table-versus-section rule from the distribution guide, states the CHANGELOG obligation for install channels, and fixes inaccurate wording about the Antigravity import and the Gemini CLI migration path.
The CHANGELOG clause keyed on pasting the standard configuration, which left a differently-shaped client such as OpenCode unclassified, and the stated rationale claimed a single edit that the badge payloads and the plugin manifest do not deliver.
It writes the launch command but not CONFIG, so a user on their own wiki would otherwise get a server pointed at English Wikipedia with no signal that anything was missing.
alistair3149
marked this pull request as ready for review
July 23, 2026 23:36
This was referenced Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reworks the install documentation. The section carried the server's launch configuration nine times over (five JSON blocks, an inline
code --add-mcppayload, two VS Code badge payloads, one Cursor base64), and they had already drifted apart. It is now stated once.167 lines to 100, nine copies to one, while adding a client and retiring a dead channel.
Commits
-yon every npx pathcommandfield, noargs), and the VS Code badges used a superseded dialect where both editions opened the same build.gemini-extension.jsonand unwires it from the release sync, where it was being synced on every release.mcpkey,commandarray,environmentrather thanenv).AGENTS.mdgains an "Adding a client" rule, so the duplication does not grow back.A correction worth stating plainly
The
-ywork was originally justified as fixing a first-run hang in GUI clients. That was wrong, and the claim is not in this branch. npm gates the install-confirmation prompt onstdin.isTTY(libnpmexec/lib/index.js:if (noTTY() || ciInfo.isCI)), and an MCP stdio server always has piped stdin, so the prompt branch is unreachable.-ystill earns its place: it matches the generated manifests, silences npx's warning, and protects users whose npm is configuredyes=false, which hard-fails outright. It is aChanged, not aFixed.Verification
lint,fmt:check,validate:server-json, and the full suite (1579 tests) pass;sync-manifests.cjsleaves the tree clean.sync-manifests→promote-changelog→git add) against a simulated version bump: exit 0. The sync's write targets were diffed against theversionscript's staging list in both directions — exact match, so no manifest can be synced and left uncommitted.Follow-ups (not in this PR)
package.json'sgit addlist duplicates thetargetsarray insync-manifests.cjswith nothing linking them. Removing a target fails loudly; adding one and forgetting the list fails silently, shipping a release where a manifest is synced but never committed. A guard inside the script would close it.CONFIG.plugins/mediawiki-mcp-server/.mcp.jsondeclares noenv, so a user who installs via the Claude Code or Codex plugin has no documented way to point the server at their own wiki. That is the smoothest install path and the one a non-technical user is most likely to take.Considered and omitted: restoring
code --add-mcp(it embedded an inline copy of the launch configuration, which is what this PR removes); per-client documentation files (the snippet is identical across clients, so it would turn one drifting file into nine); a hosted install page; and any restructuring around registries, whose own documentation disclaims being a client-facing install layer.🤖 Generated with Claude Code