Skip to content

Fix docs package npx scaffolding command#186

Open
wowsofine wants to merge 1 commit into
QuantGeekDev:mainfrom
wowsofine:codex/docs-cli-npx-package
Open

Fix docs package npx scaffolding command#186
wowsofine wants to merge 1 commit into
QuantGeekDev:mainfrom
wowsofine:codex/docs-cli-npx-package

Conversation

@wowsofine

Copy link
Copy Markdown

Summary

  • replace npx create-docs-mcp / npx create-docs-server examples with npx -p @mcpframework/docs create-docs-mcp
  • align docs package references from @mcp-framework/docs to the published @mcpframework/docs package name
  • update generated project templates and CLI usage text to match the published package/bin names

Why

The current README example asks users to run npx create-docs-mcp my-api-docs, but create-docs-mcp is 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 version returns E404
  • npx -y -p @mcpframework/docs@0.1.0 create-docs-mcp my-api-docs generates a project with @mcpframework/docs in dependencies
  • npm run build
  • cd packages/docs && npm run build && npm test -- --runInBand
  • rg "@mcp-framework/docs|npx create-docs-mcp|npx create-docs-server" README.md packages/docs docs/docs-package returns no matches
  • git diff --check

Notes

Root npm run lint currently fails on existing lint errors in dist/ and source files unrelated to this docs change. Root npm test -- --runInBand currently fails on Node 25 with jsonwebtoken / buffer-equal-constant-time prototype errors in existing OAuth/serverless suites, while many unrelated suites pass. This PR does not touch those files or dependencies.

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.

1 participant