Skip to content

docs(peek): harden llms-install.md for Windows + Cline agents#128

Merged
harry-harish merged 1 commit into
mainfrom
feat/harden-llms-install-windows
Jun 30, 2026
Merged

docs(peek): harden llms-install.md for Windows + Cline agents#128
harry-harish merged 1 commit into
mainfrom
feat/harden-llms-install-windows

Conversation

@harry-harish

@harry-harish harry-harish commented Jun 30, 2026

Copy link
Copy Markdown
Member

What

Hardens llms-install.md (peek's Cline-Marketplace install script) for Windows + Cline agents — from a real Cline-on-Windows test run that hit a transient malformed-tool-call while following it. Docs only, no changeset.

  • Step 3 — split npm install -g @peekdev/cli && peek init into two separate commands; && chaining is invalid in Windows PowerShell 5.1 (the stock Windows default shell). Also flags peek init as interactive.
  • Step 1 — state explicitly it's a config-file edit (not a shell command) and name each client's config path (cline_mcp_settings.json, ~/.cursor/mcp.json, ~/.claude.json), so an agent doesn't wrongly route it to execute_command.
  • Step 2 — make verification reload-aware (peek's MCP tools only appear after the client reloads the config) and note list_recent_sessions is an MCP tool, not a CLI.

Net effect: fewer ways for an agent to emit a malformed/empty shell command while following the doc → higher first-try success for Cline Marketplace installs (submitted as cline/mcp-marketplace#1911).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified setup steps for the MCP server configuration, including writing/editing a JSON config instead of running it as a command.
    • Added clearer guidance on when tools become available after reloading the client.
    • Explained that list_recent_sessions is an MCP tool, not a command-line command.
    • Updated native host setup instructions to use separate commands and added a Windows PowerShell note.

From a real Cline-on-Windows install run:
- Step 3: split `npm install -g @peekdev/cli && peek init` into two commands —
  `&&` chaining is invalid in Windows PowerShell 5.1 (the stock Windows shell).
- Step 1: state explicitly it's a config-FILE edit (not a shell command) and name
  each client's config path, so an agent doesn't route it to execute_command.
- Step 2: make verification reload-aware (peek's tools appear only after the
  client reloads) and note list_recent_sessions is an MCP tool, not a CLI.

Docs only — no changeset, no published-package change.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: harry-harish <22562634+harry-harish@users.noreply.github.com>
@harry-harish

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 811598bd-55a6-428d-a49f-2b03381a4a07

📥 Commits

Reviewing files that changed from the base of the PR and between 12f0464 and a3c33f4.

📒 Files selected for processing (1)
  • llms-install.md

📝 Walkthrough

Walkthrough

llms-install.md updated across three sections: Step 1 clarifies the JSON block is a config-file edit; Step 2 expands to note tools appear only after client reload and that list_recent_sessions is an MCP tool; Step 3 splits the chained install command into two separate commands with a Windows PowerShell compatibility note.

Changes

Installation Guide Clarifications

Layer / File(s) Summary
Step 1–3 instruction rewrites
llms-install.md
Step 1 reframes the JSON snippet as a config-file edit; Step 2 adds reload requirement, MCP tool framing, and expected pre-capture response; Step 3 splits npm install -g @peekdev/cli && peek init into two commands with an explicit Windows PowerShell note against chaining.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Cubenest/rrweb-stack#125: Initial version of the same llms-install.md guide that this PR refines across the server config, verification, and native host setup steps.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs-only changes for Windows and Cline-specific Peek installation guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/harden-llms-install-windows

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

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

@harry-harish harry-harish merged commit 4f29b38 into main Jun 30, 2026
7 checks passed
@harry-harish harry-harish deleted the feat/harden-llms-install-windows branch June 30, 2026 06:45
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