Files
mcp-use__mcp-use/docs/images/DeploySmall.svg
Andrew Khadder 68afda5885 docs(typescript): review and rewrite TypeScript docs (MCP-2466) (#1780)
* docs: remove stale feedback block and orphaned anchor from docs.json

* chore(docs): make Typescript more prominent

* chore(docs): Update `welcome.mdx`

* docs: rewrite TypeScript quickstart and welcome pages

Refocus the quickstart on create-mcp-use-app (scaffold, run, and deploy a
first MCP server) and drop the agent/client/server primer table and
diagram. Convert the welcome page's server + widget example from Tabs to
CodeGroup and tighten the intro wording.

* docs: remove stale server templates page and fix its references

Delete the typescript/server/templates page and repoint the home
templates tip to the quickstart, which now covers create-mcp-use-app.

* docs(typescript): fix dead example links to real example paths

The 'see a full example' links pointed at GitHub folders that 404 or
contain only a README. Corrected to the real runnable examples under
libraries/typescript/packages/mcp-use/examples/, verified against
origin/main (incl. matching cd commands):

- installation: examples/server -> packages/.../examples/server
- client-configuration: a .py link -> real TS multi-server example
- code-mode: examples/client/* -> examples/agent/code-mode/*
- elicitation, sampling, notifications: server/X -> server/features/X
- supabase: server/supabase -> server/deployment/supabase
- clerk: restore missing packages/mcp-use/ path segment

Quickstart links were already fixed by the quickstart rewrite (e6903716).
Part of the docs audit (MCP-2466).

* docs(typescript): rewrite Agent and Client introduction pages

Rewrite the Agent and Client intro pages to be task-oriented and
scannable: concise feature lists with cross-links, runnable quick-start
examples, and added API reference sections. Drop stale CodeSandbox
embeds and outdated model names.

* docs(typescript): fix MCPServer class name casing in server reference

The API Reference heading, prose, and class signature used McpServer;
the real SDK export is MCPServer. Corrected all three occurrences in
server/index.mdx.

* docs: add redirect for bare /typescript/server path

Routes the bare /typescript/server path to its index page now that the
server section has been restructured.

Claude-Session: https://claude.ai/code/session_015uioJjKTAZXGQpbXHUHZWp

* docs(typescript): fix broken code examples across MCP Server & Apps section

Fix all 102 confirmed code defects found in the MCP Server & MCP Apps
documentation audit (47 pages, 401 code blocks), verified against the
mcp-use@1.32 SDK source. The recurring patterns that made copy-pasted
examples fail to compile or run are now corrected everywhere they appeared:

- server.start() -> await server.listen() (no start() method exists)
- bare-object tool returns wrapped in object()/text() response helpers;
  catch blocks renamed so they no longer shadow the error() helper
- prompt messages use role:"user" with typed { type:"text" } content
  instead of the invalid role:"system" + bare-string shape
- auth reads ctx.auth.user.userId (not ctx.auth.userId); user fields live
  under ctx.auth.user, scopes/permissions stay top-level
- security: remove verifyJwt: process.env.NODE_ENV === 'production' from all
  six OAuth provider pages (off-prod it skips signature verification and
  accepts forged tokens); rely on the secure default, with a warning never
  to disable it
- correct import subpaths: Logger/MCPClient from mcp-use, response helpers
  and server symbols from mcp-use/server, MCPClient as BrowserMCPClient from
  mcp-use/browser; drop the unexported getMcpAppsBridge
- useWidget generics use the real <TProps, TState, TOutput, ...> order;
  remove the non-existent notifyIntrinsicHeight (auto-size via McpUseProvider)
- fix the deployment URL to <id>.run.mcp-use.com/mcp, add missing z/helper
  imports, add the --branch/--dockerfile CLI options, and clean up em dashes
  and bare/malformed code fences

Each page was fixed and then independently re-verified against the SDK
source, with a repo-wide pattern sweep confirming no instances remain.
Structural IA changes (moving widget-components to /react/, orphan
redirects) are intentionally deferred to the docs rewrite.

* docs(typescript): restructure MCP Server & MCP Apps IA

Promote MCP Apps to its own top-level section in the TypeScript SDK Docs tab and move the 9 React widget-component pages out of /server/widget-components/ into /typescript/react/.

- Move 9 React component pages to typescript/react/ (git renames) with 9 redirects
- Promote MCP Apps to a top-level group (Overview pages + React subgroup)
- Remove the duplicate MCP Apps group from the Home product nav; rehome guides/chatgpt-apps-flow under MCP Apps so it no longer orphans
- Move cli-reference out of MCP Server into a new Tooling group
- Relocate response-helpers -> Core Components, openapi -> Advanced Features, nextjs-drop-in -> Deployment
- Repoint all widget-components links to /typescript/react/
- Fix 3 broken anchor links (inspector CLI env var, mcp-apps metadata, auth providers)

Structure-only change; no page content rewrites. Refs MCP-2466.

* docs: refresh TypeScript server app docs

* docs: add TypeScript API reference

* docs: streamline TypeScript server navigation

* docs: rewrite core TypeScript server guides

* docs: rewrite advanced TypeScript server guides

* docs: rewrite TypeScript server OAuth guides

* docs: rewrite TypeScript server session storage guides

* docs: rewrite MCP Apps section

* docs: add TypeScript MCP client API reference

* docs: add TypeScript MCP agent API reference

* docs: reorder TypeScript API reference nav

* docs: reorganize TypeScript tooling nav

* docs: rewrite inspector guides

* docs: rewrite MCP server tunneling guide

* docs: rewrite CLI client and reference docs

* docs: finalize TypeScript documentation rewrite

* docs: move inspector updates under get started

* Fix Mintlify validation errors

* Fix Mintlify broken links

* docs: update Manufact Cloud deployment guide

* chore: retrigger Mintlify docs preview

* Fix MDX comment syntax on home page

* docs: rework TypeScript server examples

* docs: fix server docs links

* docs: restore SDK links in home sidebar

* docs: move SDK links to end of home sidebar
2026-06-29 10:05:13 -07:00

56 lines
2.2 KiB
XML

<svg
width="183"
height="41"
viewBox="0 0 183 41"
fill="none"
xmlns="http://www.w3.org/2000/svg"
>
<path
d="M0 6.15C0 4.51892 0.632141 2.95464 1.75736 1.80129C2.88258 0.647945 4.4087 0 6 0H177C178.591 0 180.117 0.647945 181.243 1.80129C182.368 2.95464 183 4.51892 183 6.15V34.85C183 36.4811 182.368 38.0454 181.243 39.1987C180.117 40.3521 178.591 41 177 41H6C4.4087 41 2.88258 40.3521 1.75736 39.1987C0.632141 38.0454 0 36.4811 0 34.85V6.15Z"
fill="url(#paint0_linear_deploy)"
/>
<path
d="M18.4983 17.1825C17.2782 18.3796 15.3001 18.3796 14.08 17.1825C12.8599 15.9855 12.8599 14.0447 14.08 12.8476C15.3001 11.6506 17.2782 11.6506 18.4983 12.8476C19.7184 14.0447 19.7184 15.9855 18.4983 17.1825Z"
fill="white"
/>
<path
d="M28.572 27.0662C27.3519 28.2632 25.3738 28.2632 24.1537 27.0662C22.9336 25.8691 22.9336 23.9283 24.1537 22.7312C25.3738 21.5342 27.3519 21.5342 28.572 22.7312C29.7921 23.9283 29.7921 25.8691 28.572 27.0662Z"
fill="white"
/>
<path
d="M17.6469 13.2494L19.4011 14.9705C19.4144 16.726 20.1036 18.4774 21.4687 19.8169C22.8339 21.1563 24.6191 21.8324 26.4083 21.8455L28.1624 23.5665L25.0696 26.601L23.2283 24.7943C23.1736 23.0955 22.4855 21.4127 21.1639 20.116C19.8422 18.8193 18.127 18.1442 16.3955 18.0905L14.5541 16.2839L17.6469 13.2494Z"
fill="white"
/>
<path
d="M19.3771 24.9343C19.3771 26.6272 17.9784 27.9995 16.2529 27.9995C14.5275 27.9995 13.1287 26.6272 13.1287 24.9343C13.1287 23.2414 14.5275 21.869 16.2529 21.869C17.9784 21.869 19.3771 23.2414 19.3771 24.9343Z"
fill="white"
/>
<path
d="M29.4995 15.0028C29.4995 16.6957 28.1008 18.0681 26.3753 18.0681C24.6499 18.0681 23.2511 16.6957 23.2511 15.0028C23.2511 13.31 24.6499 11.9376 26.3753 11.9376C28.1008 11.9376 29.4995 13.31 29.4995 15.0028Z"
fill="white"
/>
<text
x="56"
y="25.5"
fill="#F0F0F0"
font-family="Inter, Arial, sans-serif"
font-size="15"
font-weight="700"
>
Deploy
</text>
<defs>
<linearGradient
id="paint0_linear_deploy"
x1="181"
y1="6.85814e-06"
x2="25.5859"
y2="36.6831"
gradientUnits="userSpaceOnUse"
>
<stop stop-color="#4D4D4E" />
<stop offset="1" stop-color="#000000" />
</linearGradient>
</defs>
</svg>