Skip to content

README: point at the documentation page instead of carrying it - #22

Merged
oblomov-dev merged 1 commit into
mainfrom
claude/entry-page-redesign-ugf6jt
Aug 18, 2026
Merged

README: point at the documentation page instead of carrying it#22
oblomov-dev merged 1 commit into
mainfrom
claude/entry-page-redesign-ugf6jt

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

Nothing on the documentation site said what this server is, so the README was carrying the whole explanation — including the part a reader needs before deciding to clone anything, which is not a thing a README can reach.

The full documentation now lives at https://abap2ui5.github.io/docs/advanced/mcp_server.html: what MCP means here and what registering a server actually does, the three setup levels and what each one buys, the client JSON for Cursor / VS Code / Claude Desktop, every tool with what the agent gets from it, and the loop they are meant to be used in.

What stays here is the quick start (level 1 plus the Claude Code line), the tool table, the operational notes that only matter once it is running — sandbox, port, timeouts, offline behaviour, the renamed-corpus note — and how to work on the repository.

Companion PR: abap2UI5/docs#156, which adds the page. It also fixes the stale ai-mcp links across the documentation — this repository is mcp-server since the rename, and the docs still pointed at the old name.

🤖 Generated with Claude Code

https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG


Generated by Claude Code

What MCP means here, the three setup levels, registering the server with
each client and the loop the tools are meant to be used in now live at
https://abap2ui5.github.io/docs/advanced/mcp_server.html, written for
somebody who has not set up an MCP server before.

What stays here is the quick start, the tool table, the operational notes
that only matter once it is running, and how to work on the repository.

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

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.

@oblomov-dev
oblomov-dev merged commit 7d11344 into main Aug 18, 2026
2 checks passed
@oblomov-dev
oblomov-dev deleted the claude/entry-page-redesign-ugf6jt branch August 18, 2026 11:34
oblomov-dev pushed a commit that referenced this pull request Aug 18, 2026
#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 added a commit that referenced this pull request Aug 18, 2026
#23)

0.1.0 is on the registry, so the Quick start no longer opens with a clone of
this repository - npx has a package to fetch. #22's shortened README shape is
kept wholesale; what changed is the substance, not the structure.

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
"exactly one binary" to resolve that, and if it did not, every command here and
the VS Code extension's fallback would be wrong. The handshake returns abap2ui5
0.1.0 and lists 14 tools.

CHANGELOG: 0.1.0 gets its 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 added; abap2UI5#2640 gates that rule across the ecosystem. The
three-level detail now lives in abap2UI5/docs, so the npm install is said there
too - docs#157.
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