Skip to content

Install from npm in the README, now that there is a package to install - #23

Merged
oblomov-dev merged 2 commits into
mainfrom
claude/repo-analysis-structure-0wpt5q
Aug 18, 2026
Merged

Install from npm in the README, now that there is a package to install#23
oblomov-dev merged 2 commits into
mainfrom
claude/repo-analysis-structure-0wpt5q

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

Description

@abap2ui5/mcp-server@0.1.0 is on the registry, so the documentation can stop asking for a clone of this repository.

  • Level 1 opens with npx --yes @abap2ui5/mcp-server; the checkout is named for what it is still actually needed for — working on the server. The linter clone stays, because AI_VIEW_CHECK_HOME needs it.
  • The client-registration snippets show npx as the default shape, with node /path/to/server.mjs as the alternative rather than the other way round.
  • The ~45 MB install — 19 MB of it the Playwright driver only run_app imports — is now stated where a reader first pays it, instead of only in RELEASING.md.

Verified against the published package rather than assumed. The bin is abap2ui5-mcp and the package is @abap2ui5/mcp-server, so npx has to fall back to "this package has exactly one binary" to resolve it — if it did not, every command in this README and the VS Code extension's fallback would be wrong:

$ npx --yes @abap2ui5/mcp-server   (real registry, stdio handshake)
initialize -> {"name":"abap2ui5","version":"0.1.0"}
tools -> 14 tools: capabilities, examples, app_guide, generation_rules,
         scaffold_app, pitfalls, scope_of, deploy_app, validate_view,
         screenshot_view, build_backend, run_app, backend, remove_app

CHANGELOG

0.1.0 gets its release date and loses the future tense — the paragraph under it still said nothing had been published, under the heading for the thing that was. A fresh ## Unreleased opens above it.

npm run check

CI here runs the test suite and nothing else, so that is what it is. abap2UI5#2640 gates the rule that every repository in the ecosystem answers to check and test.

RELEASING.md

The two "after a release" items are done; they stay as the checklist for the release after a rename, which is when they come back.

How to test

npm ci && npm run check

# pass 54 / # fail 0 / # skipped 0.

Checklist

  • npm run check passes
  • npx resolution verified against the published 0.1.0, not assumed
  • No server behaviour changed — docs, changelog and one script

Generated by Claude Code

0.1.0 is on the registry, so level 1 no longer opens with a clone of this
repository. `npx --yes @abap2ui5/mcp-server` is the command, and the checkout
is named for what it is actually still needed for - working ON the server. The
client-registration snippets follow: npx as the default shape, `node
/path/to/server.mjs` as the alternative.

Verified against the published package rather than assumed, because the bin is
`abap2ui5-mcp` and the package is `@abap2ui5/mcp-server` - npx has to fall back
to "this package has exactly one binary" to resolve that, and if it did not,
every command in this README and the VS Code extension's fallback would be
wrong. It does: the handshake returns abap2ui5 0.1.0 and lists 14 tools.

The ~45 MB install, 19 MB of it the Playwright driver only run_app imports, is
now stated where a reader first pays it instead of only in RELEASING.md.

CHANGELOG: 0.1.0 keeps a date and loses the future tense - the paragraph under
it still said nothing had been published, under the heading for the thing that
was. A fresh Unreleased opens above it.

npm run check is added while here - CI runs the test suite and nothing else, so
that is what it is. Every repository in the ecosystem answers to that name now.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PLDFPfAK1MGq6qHeC6KKWH
Copilot AI lite review requested due to automatic review settings August 18, 2026 11:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

#22 moved the three setup levels into the documentation page and left a Quick
start here. That is the better shape and it wins the conflict wholesale; what
survives from this branch is only the substance - level 1 no longer clones this
repository, because npx now has a package to fetch.

The three-level detail this README used to carry is in abap2UI5/docs
(advanced/mcp_server), so the npm install has to be said there too. Separate
repository, separate pull request.
@oblomov-dev
oblomov-dev merged commit 31c67d1 into main Aug 18, 2026
2 checks passed
@oblomov-dev
oblomov-dev deleted the claude/repo-analysis-structure-0wpt5q branch August 18, 2026 11:53
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