Document distribution and inline the local-build client config#484
Merged
Conversation
Add docs/distribution.md for contributors adding an install channel, editing a plugin manifest, or testing an install before publishing. It records the channel map, the constraints that fix the Claude Code and Codex plugin layout, the per-manifest field list that scripts/sync-manifests.cjs overwrites, the three edits that wire a new manifest into that sync, and the local-directory marketplace install that exercises a plugin without publishing. Point AGENTS.md at the new page, add it to the genres table in docs/documentation-conventions.md, and shorten the sync bullet in docs/releasing.md to a link so the field list has a single home. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove mcp.json and mcp.docker.json. No client loads a repository-root mcp.json automatically, both files carried placeholder paths that had to be edited before use, and docs/testing.md was their only reader. Their command and args now sit inline at the step that uses them, matching how the README presents client configuration. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
alistair3149
force-pushed
the
worktree-distribution-docs
branch
from
July 23, 2026 20:34
5140316 to
0a1f935
Compare
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.
Two independent changes, one per commit: record how distribution works, and move the client-config examples to where they are read.
Document the distribution channels and plugin layout
New
docs/distribution.md, for contributors adding an install channel, editing a plugin manifest, or testing an install before publishing. It records:.mcpbbundle, Docker image, Gemini CLI extension, and the two plugin marketplaces), and the rule for when a client earns a committed manifest versus a READMEnpxsnippet..mcp.jsonthat Claude Code discovers and Codex references by path, and the differingsourceshapes. Also why.mcp.jsonmust stay out of the repository root, since Claude Code would load it as a project server for anyone working in this repository.scripts/sync-manifests.cjsoverwrites. Each of the seven manifests takes a different subset, so the table is the contract: a field in it is overwritten at release, anything else is hand-maintained.git addlist in theversionscript. Missing that one syncs the file but leaves it out of the release commit.AGENTS.mdpoints at the page, it has a row in thedocumentation-conventions.mdgenres table, and the sync bullet indocs/releasing.mdis shortened to a link so the field list has a single home.Remove
mcp.jsonandmcp.docker.jsonNo client loads a repository-root
mcp.jsonautomatically (Claude Code uses.mcp.json, Cursor.cursor/mcp.json, VS Code.vscode/mcp.json), both files carried placeholder paths that had to be edited before use, anddocs/testing.mdwas their only reader. Theircommandandargsnow sit inline at the step that uses them, matching how the README presents client configuration. This also removes themcp.json/.mcp.jsonnear-collision in the repository root.Verification
lint,fmt:check, andvalidate:server-jsonpass; full suite green (1579 tests).claude plugin marketplace addrejects a bare.and requires./; both CLIs accept./, which is the form the doc uses.targetsarray.commandandargswere diffed against the deleted files argument by argument.Considered, omitted: a
CHANGELOG.mdentry, since neither change alters observable server behaviour; andglama.json, which is directory-listing metadata rather than an install channel.🤖 Generated with Claude Code