Skip to content

Change smithery link#207

Merged
wonderwhy-er merged 2 commits into
mainfrom
change-smithery-link
Aug 13, 2025
Merged

Change smithery link#207
wonderwhy-er merged 2 commits into
mainfrom
change-smithery-link

Conversation

@wonderwhy-er

@wonderwhy-er wonderwhy-er commented Aug 13, 2025

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Updated installation guidance to use the Smithery web interface instead of CLI, with a clear step-by-step flow (visit Smithery, log in, select Claude Desktop client, install with key, restart the app).
    • Clarified manual updates: revisit Smithery and reinstall; removed outdated CLI uninstall/update instructions.
    • Removed deprecated CLI command examples and refreshed wording for clarity.
    • Retained the auto-updates note, repositioned after the new web-based guidance.

@coderabbitai

coderabbitai Bot commented Aug 13, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates replace Smithery CLI installation with a web-based flow in README.md and docs/index.html. Instructions now direct users to the Smithery webpage, login, select Claude Desktop, install with a provided key, and restart. Manual update/uninstall references are adjusted to use the web interface; CLI commands are removed.

Changes

Cohort / File(s) Summary
Smithery install docs (web UI shift)
README.md, docs/index.html
Replace CLI-based Smithery install with step-by-step web UI instructions; remove CLI install/uninstall commands; update manual update guidance to reinstall via Smithery page; keep auto-update note; minor wording changes reflecting “via Smithery” and web interface emphasis.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

A rabbit taps the docs with glee,
“No more CLI—just click with me!”
Hop to Smithery, keys in paw,
Install, restart—no lines of law.
Burrow updated, carrots aligned,
Webby warren, streamlined, refined. 🥕✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch change-smithery-link

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (4)
README.md (2)

108-110: Fix markdownlint MD034 (bare URL) and minor grammar

  • Convert the bare URL to an autolink or markdown link to satisfy markdownlint (MD034).
  • Use “Log in” (verb) instead of “Login” (noun).

Apply this diff:

-1. **Visit the Smithery page:** https://smithery.ai/server/@wonderwhy-er/desktop-commander
-2. **Login to Smithery** if you haven't already
+1. **Visit the Smithery page:** <https://smithery.ai/server/@wonderwhy-er/desktop-commander>
+2. **Log in to Smithery** if you haven't already

116-118: Add “Uninstall” guidance for parity with other options

Option 3 currently lacks uninstall instructions. Add a brief note to keep consistency with other install options.

Proposed insertion after Line 117:

 **✅ Auto-Updates:** Yes - automatically updates when you restart Claude  
 **🔄 Manual Update:** Visit the Smithery page and reinstall  
+**🗑️ Uninstall:** Open the Smithery page and remove/uninstall the Claude Desktop installation for Desktop Commander

Verification: If Smithery’s UI uses a different label (e.g., “Remove” vs “Uninstall”), adjust wording accordingly. I can search/adjust once you confirm the exact UI wording.

docs/index.html (2)

1303-1303: Minor grammar: “Log in” (verb) vs “Login” (noun)

-<li><strong>Login to Smithery</strong> if you haven't already</li>
+<li><strong>Log in to Smithery</strong> if you haven't already</li>

1299-1307: Add an explicit note that the Smithery CLI install is deprecated

Mirror the README’s deprecation note to avoid mixed guidance between pages.

                         <ol style="color: #121212; margin: 15px 0; padding-left: 20px;">
                             <li><strong>Visit the Smithery page:</strong> <a href="https://smithery.ai/server/@wonderwhy-er/desktop-commander" target="_blank" style="color: #0078D7;">https://smithery.ai/server/@wonderwhy-er/desktop-commander</a></li>
                             <li><strong>Login to Smithery</strong> if you haven't already</li>
                             <li><strong>Select your client</strong> (Claude Desktop) on the right side</li>
                             <li><strong>Install with the provided key</strong> that appears after selecting your client</li>
                             <li><strong>Restart Claude Desktop</strong></li>
                         </ol>
+
+                        <p><em>The previous Smithery CLI installation method is no longer supported. Please use the web interface for installation and updates.</em></p>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 848f215 and 25b50ef.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • docs/index.html (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
docs/index.html (1)
uninstall-claude-server.js (2)
  • updateUninstallStep (396-406)
  • uninstall (651-737)
🪛 markdownlint-cli2 (0.17.2)
README.md

108-108: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (4)
README.md (2)

106-114: Smithery section rewrite aligns with PR objective

Switching from CLI to the web interface is clear and user-friendly.


114-114: Nice deprecation notice

Calling out that the CLI method is no longer supported will prevent confusion for returning users.

docs/index.html (2)

1299-1311: Web flow update reads clearly and matches README

The steps are concise and align with the README’s new Smithery web-based guidance.


1299-1311: Ensure uninstall guidance is consistent for Smithery installs

Elsewhere on this page (Lines 1503–1505), uninstall instructions use an npm command. That won’t remove a Smithery-managed install. Consider adding a short note here (or in the global uninstall section) that Smithery installs should be removed via the Smithery web interface.

I can draft a small callout under the Smithery tab and in the “How to remove Desktop Commander” section, if you confirm the exact wording of the Smithery UI action (e.g., “Uninstall” vs “Remove”).

Comment thread docs/index.html
<p>Install via the Smithery web interface:</p>

<ol style="color: #121212; margin: 15px 0; padding-left: 20px;">
<li><strong>Visit the Smithery page:</strong> <a href="https://smithery.ai/server/@wonderwhy-er/desktop-commander" target="_blank" style="color: #0078D7;">https://smithery.ai/server/@wonderwhy-er/desktop-commander</a></li>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add rel="noopener" to external link opened with target="_blank"

Prevent potential reverse tabnabbing. Many other links in this file already include rel attributes; mirror that here.

-<a href="https://smithery.ai/server/@wonderwhy-er/desktop-commander" target="_blank" style="color: #0078D7;">https://smithery.ai/server/@wonderwhy-er/desktop-commander</a>
+<a href="https://smithery.ai/server/@wonderwhy-er/desktop-commander" target="_blank" rel="noopener" style="color: #0078D7;">https://smithery.ai/server/@wonderwhy-er/desktop-commander</a>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<li><strong>Visit the Smithery page:</strong> <a href="https://smithery.ai/server/@wonderwhy-er/desktop-commander" target="_blank" style="color: #0078D7;">https://smithery.ai/server/@wonderwhy-er/desktop-commander</a></li>
<li><strong>Visit the Smithery page:</strong> <a href="https://smithery.ai/server/@wonderwhy-er/desktop-commander" target="_blank" rel="noopener" style="color: #0078D7;">https://smithery.ai/server/@wonderwhy-er/desktop-commander</a></li>
🤖 Prompt for AI Agents
In docs/index.html around line 1302, the external anchor opening with
target="_blank" lacks rel="noopener" which risks reverse tabnabbing; update the
<a> tag to include rel="noopener" (and rel="noreferrer" if your project prefers)
alongside the existing target attribute so it matches other external links in
this file and prevents the new tab from gaining access to the opener.

Comment thread README.md
Comment on lines +106 to 118
To install Desktop Commander for Claude Desktop via [Smithery](https://smithery.ai/server/@wonderwhy-er/desktop-commander):

```bash
npx -y @smithery/cli install @wonderwhy-er/desktop-commander --client claude
```
1. **Visit the Smithery page:** https://smithery.ai/server/@wonderwhy-er/desktop-commander
2. **Login to Smithery** if you haven't already
3. **Select your client** (Claude Desktop) on the right side
4. **Install with the provided key** that appears after selecting your client
5. **Restart Claude Desktop**

The old command-line installation method is no longer supported. Please use the web interface above for the most reliable installation experience.

**✅ Auto-Updates:** Yes - automatically updates when you restart Claude
**🔄 Manual Update:** Re-run the Smithery install command
**🗑️ Uninstall:** `npx -y @smithery/cli uninstall @wonderwhy-er/desktop-commander --client claude`
**🔄 Manual Update:** Visit the Smithery page and reinstall

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Scan repo for any remaining references to the deprecated Smithery CLI

Ensure all docs are consistent and no lingering CLI commands remain.


🏁 Script executed:

#!/bin/bash
# Find lingering Smithery CLI references or commands across the repo
rg -n -A2 -B2 $'@smithery/cli|smithery cli|smithery\\s+cli|npx\\s+-y\\s+@smithery/cli|Install automatically via Smithery|Smithery CLI'

Length of output: 304


Remove deprecated Smithery CLI references from FAQ.md

We still have lingering CLI instructions in the FAQ that need to be removed to keep all documentation consistent with the new web-only install method.

File: FAQ.md
Lines: ~125–129
Excerpt to remove:

- **Option 1: Via Smithery**
- ```bash
- npx -y @smithery/cli install @wonderwhy-er/desktop-commander --client claude
- ```

Ensure no other mentions of @smithery/cli, smithery cli, or npx -y @smithery/cli remain elsewhere.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

108-108: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
FAQ.md around lines ~125–129: remove the deprecated CLI instructions by deleting
the bash code block lines containing "npx -y @smithery/cli install
@wonderwhy-er/desktop-commander --client claude" and the surrounding
triple-backtick fence so the snippet is gone; then search the repository for any
occurrences of "@smithery/cli", "smithery cli", or "npx -y @smithery/cli" and
remove or replace them with a short pointer to the Smithery web install (e.g.,
"Install via the Smithery web interface") so no CLI references remain.

@wonderwhy-er wonderwhy-er merged commit bd88788 into main Aug 13, 2025
2 checks passed
@wonderwhy-er wonderwhy-er deleted the change-smithery-link branch August 15, 2025 06:39
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