Skip to content

docs(server): replace stale package README with a stub linking the canonical sources#64

Merged
johnxie merged 2 commits into
mainfrom
readme/m3-stub-server-readme
Jun 28, 2026
Merged

docs(server): replace stale package README with a stub linking the canonical sources#64
johnxie merged 2 commits into
mainfrom
readme/m3-stub-server-readme

Conversation

@johnxie

@johnxie johnxie commented Jun 28, 2026

Copy link
Copy Markdown
Member

Summary

packages/server/README.md (the npm package README) is stale and thin — "MCP server for Taskade's public API," no tool count, no v2, no surface note — and contradicts the polished root README. npm readers hit it and never reach the real story. Per the roadmap, the fix is stub-and-link rather than parity: two full READMEs would only drift again.

What changed

Before After
Thin standalone README ("MCP server for Taskade's public API"), no tool count / no v2 / raw JSON token placeholder Concise stub: names it Workspace MCP, states 62 tools, links the root README + Workspace MCP guide + the "which MCP" guide; keeps a minimal quick-start + canonical token link

Why it matters (the David cohort)

The npm/package reader gets the correct product name, the real tool count, and one click to the full docs — instead of a contradictory stub.

Design lens

Geist — one canonical server doc; eliminate the second source of truth that drifts.

Verification / zero-regression

  • Intentional content reduction (stub-and-link is the chosen strategy).
  • Token URL is the canonical https://www.taskade.com/settings/api.
  • No second 62-tool table authored; package.json untouched.

Merge order

Independent of M1. Note: M2 deliberately does NOT touch this file (to avoid a conflict) — M3 carries the correct "Workspace MCP" naming for the package README.


🤖 Authored with Claude Code (multi-agent verified)

@changeset-bot

changeset-bot Bot commented Jun 28, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3321465

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

@johnxie

johnxie commented Jun 28, 2026

Copy link
Copy Markdown
Member Author

Review

Approve — the optional link-text nit is now fixed.

Verification notes:

  • Diff scope confirmed: only packages/server/README.md (+11/−63); package.json untouched.
  • All four links return HTTP 200: root README (github.com/taskade/mcp#readme), workspace-mcp.md, genesis-app-mcp.md, and the canonical token URL https://www.taskade.com/settings/api.
  • Claims accurate: "Workspace MCP", "62 tools", package name @taskade/mcp-server, and the npx -y @taskade/mcp-server quick-start all match the package and ground truth; the "which MCP" bullet correctly reflects the Workspace vs Genesis App vs Connectors surfaces.
  • Intentional content reduction (stub-and-link), and the github.com/taskade/docs/blob/main source URLs are by design.

Update: the optional nit — the Workspace MCP guide bullet's link text read docs.taskade.com while its href is a github.com/taskade/docs/... source URL — is now fixed; the link text matches its destination.

Reviewed via a two-lens pass (pr-review-toolkit:code-reviewer + an independent doc-correctness/link verifier) with adversarial verification.

cc @deanzaka @lxcid

@johnxie johnxie merged commit d5622cb into main Jun 28, 2026
1 check passed
@johnxie johnxie deleted the readme/m3-stub-server-readme branch June 28, 2026 14:55
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