Skip to content

Conversation

@jack-arturo
Copy link
Member

Summary

  • Updated Claude Desktop configuration examples to use the args array format instead of inline command
  • This prevents Windows from mangling the package name by converting / to \

Problem

Windows can convert forward slashes to backslashes during config parsing, causing:

  • @verygoodplugins/mcp-freescout@verygoodplugins\mcp-freescout

npm rejects the malformed package name.

Solution

Use the args array approach (already used in Cursor IDE instructions):

{
  "command": "npx",
  "args": ["@verygoodplugins/mcp-freescout@latest"]
}

Instead of:

{
  "command": "npx @verygoodplugins/mcp-freescout@latest"
}

Test plan

  • Verified Cursor IDE instructions already use the correct format
  • Test on Windows machine to confirm fix works

Fixes #5

🤖 Generated with Claude Code

Windows can convert forward slashes to backslashes during config parsing,
causing @verygoodplugins/mcp-freescout to become @verygoodplugins\mcp-freescout
which npm rejects.

Using the args array approach (already used in Cursor IDE instructions) avoids
this issue by keeping the package name as a separate argument.

Fixes #5

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jack-arturo jack-arturo linked an issue Jan 5, 2026 that may be closed by this pull request
@coderabbitai
Copy link

coderabbitai bot commented Jan 5, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated MCP server configuration examples to use an alternative command invocation format for improved compatibility and clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

Walkthrough

README.md is updated to modify MCP server configuration blocks by separating the npx command from its arguments. The command invocation changes from a single-line format to a format where "command" and "args" are declared separately, affecting two configuration examples in the documentation.

Changes

Cohort / File(s) Summary
Documentation Configuration Update
README.md
Modified two MCP server configuration blocks to separate npx command from arguments. Changed from "command": "npx @verygoodplugins/mcp-freescout@latest" to "command": "npx" with "args": ["@verygoodplugins/mcp-freescout@latest"]. This resolves Windows path separator conversion issues where forward slashes in package names were being converted to backslashes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating Claude Desktop config to use args array format for Windows compatibility.
Description check ✅ Passed The description clearly explains the Windows path separator issue, the proposed solution, and references the linked issue.
Linked Issues check ✅ Passed The PR updates README.md to use args array format with 'npx' command instead of inline command, directly addressing issue #5's requirement for Windows compatibility.
Out of Scope Changes check ✅ Passed All changes are focused on updating the README.md configuration examples to resolve the Windows path issue, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/5-windows-readme-instruction-compatibility

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dde87b0 and fb1e225.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
Repo: verygoodplugins/mcp-freescout PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-05T01:36:41.541Z
Learning: Applies to src/index.ts : The MCP server CLI entry point is `src/index.ts`, which builds to `dist/index.js` and is exposed as `mcp-freescout`
Learnt from: CR
Repo: verygoodplugins/mcp-freescout PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-05T01:36:32.147Z
Learning: Applies to src/index.ts : MCP server entry point and tool registration should be in src/index.ts
📚 Learning: 2026-01-05T01:36:41.541Z
Learnt from: CR
Repo: verygoodplugins/mcp-freescout PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-05T01:36:41.541Z
Learning: Applies to src/index.ts : The MCP server CLI entry point is `src/index.ts`, which builds to `dist/index.js` and is exposed as `mcp-freescout`

Applied to files:

  • README.md
🔇 Additional comments (3)
README.md (3)

52-53: Configuration format update looks good.

The switch from an inline command string to a split command + args array format correctly addresses the Windows path separator issue. The package name and version specification are preserved in the args array where they won't be corrupted by Windows path parsing.


82-83: Cursor IDE configuration updated consistently.

The Cursor IDE example mirrors the Claude Desktop format change, maintaining consistency across both configuration sections. This ensures users get the same working pattern regardless of their MCP client choice.


125-126: Configuration format consistent across all examples.

Both the Manual Installation section (node-based, already correct) and Advanced Configuration Example properly use the command+args pattern. This ensures all documented configurations follow the same safe pattern for cross-platform compatibility.

Also applies to: 552-553


Comment @coderabbitai help to get the list of available commands and usage tips.

@jack-arturo jack-arturo merged commit 85168c7 into main Jan 5, 2026
5 checks passed
@jack-arturo jack-arturo deleted the fix/5-windows-readme-instruction-compatibility branch January 5, 2026 01:57
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.

Windows Readme instruction compatibility

2 participants