Fix docs package npx scaffolding command#186
Open
wowsofine wants to merge 1 commit into
Open
Conversation
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.
Summary
npx create-docs-mcp/npx create-docs-serverexamples withnpx -p @mcpframework/docs create-docs-mcp@mcp-framework/docsto the published@mcpframework/docspackage nameWhy
The current README example asks users to run
npx create-docs-mcp my-api-docs, butcreate-docs-mcpis not a published npm package. The executable is provided by@mcpframework/docs, so npm needs the package source specified.Validation
npm view create-docs-mcp versionreturns E404npx -y -p @mcpframework/docs@0.1.0 create-docs-mcp my-api-docsgenerates a project with@mcpframework/docsin dependenciesnpm run buildcd packages/docs && npm run build && npm test -- --runInBandrg "@mcp-framework/docs|npx create-docs-mcp|npx create-docs-server" README.md packages/docs docs/docs-packagereturns no matchesgit diff --checkNotes
Root
npm run lintcurrently fails on existing lint errors indist/and source files unrelated to this docs change. Rootnpm test -- --runInBandcurrently fails on Node 25 withjsonwebtoken/buffer-equal-constant-timeprototype errors in existing OAuth/serverless suites, while many unrelated suites pass. This PR does not touch those files or dependencies.