Skip to content

docs: Windsurf, Cline & VS Code setup guides (closes #16)#46

Merged
johnxie merged 1 commit into
mainfrom
docs/client-guides-windsurf-cline
Jun 5, 2026
Merged

docs: Windsurf, Cline & VS Code setup guides (closes #16)#46
johnxie merged 1 commit into
mainfrom
docs/client-guides-windsurf-cline

Conversation

@johnxie

@johnxie johnxie commented Jun 5, 2026

Copy link
Copy Markdown
Member

What & why

Quick Start documented only Claude Desktop and Cursor, yet the tagline advertises Windsurf. Closes #16 by adding copy-paste setup for the remaining major clients.

Changes (README Quick Start)

  • §4 Windsurf~/.codeium/windsurf/mcp_config.json (or Settings → Cascade → MCP).
  • §5 Cline — Cline MCP Servers panel config.
  • §6 VS Code.vscode/mcp.json using VS Code's servers key + ${input:…} secret prompt.
  • HTTP/SSE renumbered §4 → §7.

Zero-regression

  • Markdown only; all JSON config blocks validated as parseable.
  • Each block mirrors the existing Claude/Cursor stdio stanza (npx -y @taskade/mcp-server + TASKADE_API_KEY).

Closes #16.

Stacked on

@johnxie johnxie requested a review from Copilot June 5, 2026 11:23
@changeset-bot

changeset-bot Bot commented Jun 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 53ba3f3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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.

Pull request overview

Updates the README Quick Start to include copy/paste configuration guides for additional MCP clients (Windsurf, Cline, and VS Code) so the documentation matches the repository’s stated client support and closes #16.

Changes:

  • Add a new Windsurf Quick Start section with an example mcp_config.json configuration.
  • Add a new Cline Quick Start section with the MCP Servers panel configuration snippet.
  • Add a new VS Code Quick Start section and renumber the existing HTTP/SSE section from §4 to §7.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

### 6. VS Code

Add a `.vscode/mcp.json` to your workspace (VS Code uses the `servers` key; `${input:…}` prompts for your key on first run):
@johnxie

johnxie commented Jun 5, 2026

Copy link
Copy Markdown
Member Author

✅ Validation & QA — ready to merge

One Copilot comment, validated as a non-issue (two legitimately different formats):

Copilot finding Verdict
VS Code .vscode/mcp.json uses servers map, but the "Install in VS Code" badge encodes a single-server {name,...} expected — the vscode:mcp/install? deeplink format (single server object) and the .vscode/mcp.json file format (servers map) are different by design; both are correct for their contexts.

QA: numbering 1–7 correct; all 5 JSON config blocks parse. Closes #16.

Confidence: high · zero regression. Merging.

@johnxie johnxie force-pushed the docs/install-badges branch from d3b9b6f to f9ac88b Compare June 5, 2026 11:59
@johnxie johnxie changed the base branch from docs/install-badges to main June 5, 2026 11:59
Quick Start covered only Claude Desktop + Cursor, though the tagline names
Windsurf. Add copy-paste stdio config blocks for Windsurf (mcp_config.json),
Cline (MCP Servers panel), and VS Code (.vscode/mcp.json, servers key +
${input:} prompt). Renumber the HTTP section accordingly.
@johnxie johnxie force-pushed the docs/client-guides-windsurf-cline branch from b43243a to 53ba3f3 Compare June 5, 2026 12:00
@johnxie johnxie merged commit 3ec42c5 into main Jun 5, 2026
@johnxie johnxie deleted the docs/client-guides-windsurf-cline branch June 5, 2026 12:00
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.

docs: Add integration guides for Windsurf, Cline, and other MCP clients

2 participants