feat: add optional postInstallInstructions to package schema#1364
Open
anneheartrecord wants to merge 1 commit into
Open
feat: add optional postInstallInstructions to package schema#1364anneheartrecord wants to merge 1 commit into
anneheartrecord wants to merge 1 commit into
Conversation
Add an optional postInstallInstructions array to the Package schema so servers can declare structured post-install steps that clients display as a checklist after downloading a package. This covers servers that require manual setup beyond installation, such as a stdio MCP server that also runs a companion system service (e.g. mind-map). Each instruction has a required description and optional command, documentation (URI), and optional fields. Instructions are informational only: clients display the text and never execute commands automatically, so there is no supply chain risk. Changes span the OpenAPI source of truth, the regenerated draft server.schema.json, the Go model used by the API, and the schema changelog.
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
1 participant
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.
Fixes #1340
What
Adds an optional
postInstallInstructionsarray to thePackageschema. It lets a server declare structured post-install steps that clients can render as a checklist after downloading a package.Why
Some servers need manual setup beyond installation. The motivating case (#1340) is
mind-map, which is both a stdio MCP server and a persistent HTTP daemon — the MCP side works immediately, but the companion web UI requires registering a system service. Today nothing inserver.jsoncommunicates this;websiteUrlcan only point to docs with no structured surface for post-install steps.Schema
Each
PostInstallInstructionhas:description(required) — human-readable step textcommand(optional) — shell command to display for the user to copydocumentation(optional, URI) — link to setup docsoptional(optional, bool) — true means the server works without this stepInstructions are informational only: clients display text and never execute commands automatically, so there is no supply chain risk.
Changes
docs/reference/api/openapi.yaml— schema source of truthdocs/reference/server-json/draft/server.schema.json— regenerated viamake generate-schemapkg/model/types.go— Go modeldocs/reference/server-json/CHANGELOG.md— Draft (Unreleased) entryOpen question for maintainers
The issue also asked whether this belongs in the core Package schema or as an extension via
_meta. This PR implements it in core Package since the steps are per-package/per-transport. Happy to move it to an extension if preferred.