Skip to content

docs: register the MCP server from an installed release - #856

Merged
bflatastic merged 4 commits into
storytold:mainfrom
sawizzle:docs/installed-release-mcp
Oct 10, 2026
Merged

bflatastic merged 4 commits into
storytold:mainfrom
sawizzle:docs/installed-release-mcp

Conversation

@sawizzle

@sawizzle sawizzle commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

The MCP docs only show registering vectorcraft-cli from a source build (target/release/...). People who
install a release (MSI, deb/rpm, the macOS CLI zip) have to work out where the CLI lives. On Windows
the MSI doesn't add it to PATH, and on macOS the CLI isn't inside the .app.

This adds a short "From an installed release" section to docs/mcp.md, covering:

  • where each package installs the CLI by default (taken from packaging/windows/*.wxs,
    packaging/linux/nfpm.yaml and packaging/macos/package.sh);
  • the matching claude mcp add commands.

It's a docs-only change, +17 lines, nothing removed. I tested the Windows path and command on Windows 11
with the 2026-10-08 release MSI. The Linux and macOS paths come from the packaging files; I haven't run them.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@bflatastic

Copy link
Copy Markdown
Member

Thanks, @sawizzle, this fills a real gap. I checked the paths against the packaging: ProgramFiles6432Folder\VectorCraft in the WiX file, /usr/bin/vectorcraft-cli in nfpm.yaml, and the vectorcraft-cli-<version>-macos-<arch>.zip asset from packaging/macos/package.sh. Two small changes, then I'll merge:

  1. Please drop the plugin link. Thanks for offering: we keep the docs to the project's own material, so third-party projects aren't linked from them.
  2. The MSI lets you choose the folder, so the Windows row should say C:\Program Files\VectorCraft\vectorcraft-cli.exe by default (wherever you installed it otherwise), not on PATH.

@Messhias

Copy link
Copy Markdown
Contributor

Small follow-up: the unofficial plugin paragraph is still in the diff. The earlier review asked to drop that link so docs/mcp.md stays on the project itself. Paths and the installed-release table look good otherwise; once the plugin blurb is gone this should be ready.

sawizzle and others added 3 commits October 9, 2026 21:50
…all folder

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…all folder

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…all folder

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sawizzle

Copy link
Copy Markdown
Contributor Author

Thanks @bflatastic and @Messhias. I made both changes:

  1. The plugin paragraph is gone; the section only covers the project's own packages.
  2. The Windows row now reads C:\Program Files\VectorCraft\vectorcraft-cli.exe by default (wherever you installed it otherwise), and the command is labelled as the default install folder.

I made the same two changes to the matching docs PRs for the other apps: storytold/photocraft#2185, storytold/filmcraft#504, storytold/lightcraft#623, storytold/pdfcraft#643, storytold/effectcraft#517 and storytold/designcraft#269. Each one still changes a single file, +17 / −0.

@Messhias

Copy link
Copy Markdown
Contributor

Checked the latest commits: plugin blurb is gone, and the Windows row/command now mark the default install folder. Looks good from here.

@bflatastic
bflatastic merged commit e15ef47 into storytold:main Oct 10, 2026
@bflatastic

Copy link
Copy Markdown
Member

Thanks for this, @sawizzle, and for the quick follow-ups! Merged: the MCP docs now say where the CLI lives in each release package. We'd love to have you on our Discord too: https://discord.gg/artcraft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants