Skip to content

docs: one-click Add to Cursor / Install in VS Code badges#42

Merged
johnxie merged 2 commits into
mainfrom
docs/install-badges
Jun 5, 2026
Merged

docs: one-click Add to Cursor / Install in VS Code badges#42
johnxie merged 2 commits into
mainfrom
docs/install-badges

Conversation

@johnxie

@johnxie johnxie commented Jun 5, 2026

Copy link
Copy Markdown
Member

What & why

The Quick Start only showed copy-paste JSON. These deep-link install badges write the npx @taskade/mcp-server config straight into the client — the highest-ROI README conversion change.

  • Add to Cursorcursor://anysphere.cursor-deeplink/mcp/install?name=taskade&config=<base64>
  • Install in VS Codevscode:mcp/install?<url-encoded config> (prompts for the API key via ${input:…})

Zero-regression

  • Markdown only; both configs decode back to the documented npx stdio config (verified round-trip).
  • Badge images via shields.io (guaranteed render); custom URI schemes are the established MCP-badge pattern (github-mcp-server etc.).

Deliberately scoped out (would 404 today)

Stacked on

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

changeset-bot Bot commented Jun 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f9ac88b

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

Adds one-click install badges to the README to make MCP setup easier in popular clients, improving Quick Start conversion without changing runtime behavior.

Changes:

  • Add a Cursor “Add to Cursor” deeplink badge that installs the npx @taskade/mcp-server stdio config.
  • Add a VS Code “Install in VS Code” deeplink badge that installs the same config and prompts for the API key via ${input:…}.

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

Comment thread README.md Outdated
[![GitHub stars](https://img.shields.io/github/stars/taskade/mcp?style=flat-square)](https://github.com/taskade/mcp)
[![License](https://img.shields.io/github/license/taskade/mcp?style=flat-square)](https://github.com/taskade/mcp/blob/main/LICENSE)

[![Add to Cursor](https://img.shields.io/badge/Add_to-Cursor-0098FF?style=flat-square)](cursor://anysphere.cursor-deeplink/mcp/install?name=taskade&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0YXNrYWRlL21jcC1zZXJ2ZXIiXSwiZW52Ijp7IlRBU0tBREVfQVBJX0tFWSI6IllPVVJfVEFTS0FERV9BUElfS0VZIn19)

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@johnxie

johnxie commented Jun 5, 2026

Copy link
Copy Markdown
Member Author

✅ Validated → fixed → ready to merge

Copilot finding Verdict Action
Cursor deeplink encodes YOUR_TASKADE_API_KEY while the README uses your-api-key-here VALID (inconsistent) Re-encoded the badge config.

QA: decoded badge config →

{"command":"npx","args":["-y","@taskade/mcp-server"],"env":{"TASKADE_API_KEY":"your-api-key-here"}}

Confidence: high · zero regression (markdown only). Merging.

@johnxie johnxie force-pushed the docs/readme-positioning branch from 7f2d343 to 2dd292a Compare June 5, 2026 11:58
johnxie added 2 commits June 5, 2026 04:59
Quick Start previously only offered copy-paste JSON config. These deep-link
badges write the npx @taskade/mcp-server config directly into the client:
- Cursor: cursor://anysphere.cursor-deeplink/mcp/install (base64 config)
- VS Code: vscode:mcp/install (url-encoded config, prompts for the API key)

One-click install converts far better than manual config.
Addresses Copilot review: the Cursor deeplink encoded YOUR_TASKADE_API_KEY
while the rest of the Quick Start uses your-api-key-here. Re-encode the badge
config to match.
@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/readme-positioning to main June 5, 2026 11:59
@johnxie johnxie merged commit a3c4ea6 into main Jun 5, 2026
@johnxie johnxie deleted the docs/install-badges branch June 5, 2026 12:03
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.

2 participants