Repository navigation
docs: point HTTP users to the hosted server in SECURITY and examples (#98) - #99
Conversation
…98) The published package runs over stdio only. SECURITY.md described an HTTP/SSE transport that exists only in the source dev script, and examples/README.md sent HTTP users to a closed issue. - SECURITY.md: state that the npm package uses stdio only. Describe the HTTP/SSE dev script as source-only and local. Point remote users to the hosted server at https://www.taskade.com/mcp (OAuth 2.0). The reporting instructions do not change. - examples/README.md: replace the closed-issue link with the hosted server and its Bearer token option. Closes #98
|
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes match the stated requirements, with no unresolved findings.
No open issues 🎉
What changed in this PR
Updates transport documentation to direct HTTP users to the hosted server, addressing #98 and complementing #96’s README cleanup.
Changes:
- Clarifies that the published package supports stdio only.
- Documents the source-only HTTP dev script and its security risks.
- Replaces the outdated issue link with hosted-server authentication guidance.
| File | Description |
|---|---|
| SECURITY.md | Distinguishes published, development, and hosted transports and their security implications. |
| examples/README.md | Directs HTTP users to the hosted server with OAuth or Bearer authentication. |
Review effort: Balanced
#98) - SECURITY.md: say that a network observer can read the token of the plain HTTP dev script, and keep the HTTPS/TLS advice from the startup note of the script. - examples/README.md: say that the hosted server needs a paid plan on the workspace.
|
@deanzaka for review. Docs only: Impact
Reader flow, beforeReader flow, afterQA
Merge order: #96 merged on 2026-10-19, so |
#98) The README on main renamed the hosted server section to "Taskade MCP server: quick start". The old #quick-start-hosted-server anchor no longer exists.
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
Summary
The published
@taskade/mcp-serverpackage runs over stdio only. Two docs still describe an HTTP path that users cannot get from npm:SECURITY.mddescribes an HTTP/SSE transport. Only the source dev script has that transport.examples/README.mdsends HTTP users to a closed issue and does not mention the hosted server.This PR points HTTP users to the hosted server at
https://www.taskade.com/mcp. It follows the README change in #96, which removes the--httpsection.Changes
SECURITY.md, "Transport Security":TASKADE_API_KEY.yarn start:serverinpackages/server). The npm package does not contain it.access_tokenquery parameter and serves plain HTTP on every network interface (port 3000 by default). A proxy can log the token and a network observer can read it. Run it only on a trusted machine and network, and put it behind HTTPS/TLS if other machines can reach it. This keeps the TLS advice that the startup note of the script prints.SECURITY.md, "Privacy": the note about the token in the URL now names the source dev script as the only place with that mode.examples/README.md: the n8n note keeps the stdio setup and replaces the closed-issue link with the hosted server. It says that the hosted server needs a paid plan on the workspace, and it names the Bearer token option for a client that cannot do OAuth.The reporting instructions in
SECURITY.mddo not change. No code, workflow orpackage.jsonchanges. No changeset: the change is docs only and does not touch a package.How I checked the facts
bin/cli.mjs. It containsnew StdioServerTransport()and no--http,startHTTPServeroraccess_token..npmignoreexcludessrc.start:serverrunstsx src/http.ts, which callsstartHTTPServerfrommcp-proxywithPORT(default 3000).mcp-proxy3.2.0 callslisten(port, "::"). A local run ofyarn start:serverwithPORT=38791showedTCP *:38791 (LISTEN).curl https://www.taskade.com/mcpreturns401, which starts the OAuth sign-in (see the README "Taskade MCP server: quick start").Risk and rollback
mainno longer shows the old--httpsection.Tests
yarn lint: exit 0.npx prettier --check SECURITY.md examples/README.md: all files pass.https://www.taskade.com/mcpreturns401(expected),https://github.com/taskade/mcpreturns200. The anchor#taskade-mcp-server-quick-startexists inREADME.mdonmain(the live repo page rendersid="user-content-taskade-mcp-server-quick-start"). feat(plugin): Ship the Taskade agent plugin with a front-door skill, six outcome skills, and manifests for Claude Code, Codex, Copilot and Gemini #105 renamed the old#quick-start-hosted-serverheading, so commit f275e3c moves both links to the new anchor.PORT=38791 yarn start:serveransweredGET /pingwithpong. I stopped it by PID after the check.Closes #98