Skip to content

fix(docs): make every user-facing command one that actually runs - #40

Merged
Edwinbhart merged 1 commit into
devfrom
fix/verified-user-commands
Aug 20, 2026
Merged

Edwinbhart merged 1 commit into
devfrom
fix/verified-user-commands

Conversation

@Edwinbhart

@Edwinbhart Edwinbhart commented Aug 20, 2026 •

Copy link
Copy Markdown
Member

Fix user-facing URLs and refresh plugin install docs

🐛 Bug Fix · 📝 Docs · 🔧 Chore

Removes the trailing slash from every user-facing occurrence of https://api.opentrace.ai/mcp/v1/ across docs and plugin metadata — the slash-free form is what the server advertises and what users should copy-paste. Also rewrites the plugin README install section to reflect the current recommended install path, and expands the MCP tools table with six newly available tools.

Complexity

🟢 Trivial · 5 files changed, 43 insertions(+), 23 deletions(-)

All five changed files are docs or package metadata. No functional code is touched, and no architectural decisions are made. The diff speaks for itself.

Review focus

Pay particular attention to the following areas:

  • Trailing slash in README.md lines 87/192/198 — these three occurrences are intentionally left with a trailing slash; they describe the CLI's internal normalisation behaviour and the exact strings it writes to config files, not commands a user types. Confirm you agree they should stay as-is.

The plugin README's install block offered three commands and none were valid
syntax: `claude plugin install` resolves `plugin@marketplace` from a registered
marketplace, so it rejects a local path, a `github:owner/repo?path=` URL, and an
npm package name alike — and `@opentrace/claude-code-plugin` was never published,
so that line was wrong twice over. Replaced with a single line verified from a
clean HOME, plus the `otx login` route and `--plugin-dir` for local work. No
"once we're listed" command this time: that is what produced the npm line.

Sweeping the rest of the user-facing docs for the same class of defect found two
more. All 13 endpoints in docs/mcp-installs.md carried a trailing slash, and none
of those instructions pass a header, so they authenticate over OAuth — where the
slash yields an RFC 8707 `resource` the authorization server does not recognise.
That is the bug fixed in the plugin in 39b6838, still live in the docs that tell
people to wire the server up by hand. And README's claim about the plugin's
default endpoint still said `/mcp/v1/`, which that same commit made untrue.

Left README's `--url` line alone: it describes normalizeMcpUrl, which really does
still canonicalise to a trailing slash, and the key-auth examples where the slash
is inert.

Also grew the tools table from 12 rows to the 19 the server advertises, matching
what plugin.json already claims.

Plugin patch-bumped so installed copies do not keep the stale README.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

@opentrace opentrace Bot 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.

✅ Approved

Trivial change.

All five changed files are docs or package metadata. No functional code is touched, and no architectural decisions are made. The diff speaks for itself.

@Edwinbhart
Edwinbhart merged commit 948b021 into dev Aug 20, 2026
6 checks passed
@codehub-agent

codehub-agent Bot commented Aug 20, 2026

Copy link
Copy Markdown

💰 Agent economics

50 agent sessions reported in the last 30 days, but none matched this PR's commits. A session matches on the author email it reports and a commit landing within ~2h of it — so check the agent's email matches the commit author, and that the work was committed in the same sitting. Sessions →

Full economics → · by CodeHub

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant