mirror of
https://github.com/mcp-use/mcp-use.git
synced 2026-09-14 18:06:01 +08:00
Andrew Khadder
68afda5885
* 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
98 lines
3.1 KiB
Plaintext
98 lines
3.1 KiB
Plaintext
---
|
|
title: "URL parameters"
|
|
description: "Open the Inspector with a selected server, tab, or embedded layout."
|
|
icon: "link"
|
|
---
|
|
|
|
{/* TODO: Add Inspector media when a screenshot or short clip would clarify the workflow. */}
|
|
|
|
Use URL parameters when you need a link that opens the Inspector on a specific server, starts a connection automatically, or restores a tab.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Purpose | Values |
|
|
| --- | --- | --- |
|
|
| `server` | Select an existing connection by server ID or URL. If no saved connection matches and the value is an HTTP(S) URL, connect to it. | Connection ID or URL string |
|
|
| `autoConnect` | Connect to a server when the Inspector loads. | URL string or URL-encoded JSON config |
|
|
| `tab` | Open a specific server tab. | `tools`, `prompts`, `resources`, `chat`, `sampling`, `elicitation`, `notifications`, `playground` |
|
|
| `tunnelUrl` | Preserve a tunnel URL while navigating. Usually set by the CLI. | URL string |
|
|
| `embedded` | Use embedded mode with reduced page chrome. | `true` |
|
|
| `embeddedConfig` | Configure embedded styling. | URL-encoded JSON config |
|
|
|
|
## Select or connect to a server
|
|
|
|
Use `server` when the Inspector should select a saved server by URL:
|
|
|
|
```text
|
|
/?server=https://mcp.example.com/mcp
|
|
```
|
|
|
|
If the server is not saved yet, the Inspector treats the HTTP(S) value like `autoConnect` and connects to it.
|
|
|
|
## Auto-connect on load
|
|
|
|
Use `autoConnect` when a link should create the connection immediately:
|
|
|
|
```text
|
|
/?autoConnect=https://mcp.example.com/mcp
|
|
```
|
|
|
|
For advanced connection options, pass a URL-encoded JSON object. The `url` field is required.
|
|
|
|
```json
|
|
{
|
|
"url": "https://mcp.example.com/mcp",
|
|
"name": "Example server",
|
|
"transportType": "http",
|
|
"connectionMode": "auto",
|
|
"connectionType": "Direct"
|
|
}
|
|
```
|
|
|
|
Supported JSON fields are `url` (required), `name`, `transportType` (`"http"` or `"sse"`), `connectionMode` (`"auto"`, `"direct"`, or `"proxy"`), `autoProxyFallback`, `connectionType` (`"Direct"` or `"Via Proxy"` for older links), `customHeaders`, `auth`, `requestTimeout`, `resetTimeoutOnProgress`, and `maxTotalTimeout`.
|
|
|
|
<Tip>
|
|
When passing a JSON object for **autoConnect**, URL-encode the value so special characters are valid in the query string.
|
|
</Tip>
|
|
|
|
## Open a tab
|
|
|
|
Use `tab` by itself to restore a view, or combine it with `server` or `autoConnect`.
|
|
|
|
```text
|
|
/?server=https://mcp.example.com/mcp&tab=tools
|
|
```
|
|
|
|
The Inspector also updates `tab` as you move between server tabs, so refreshes keep the current view.
|
|
|
|
## Embedded mode
|
|
|
|
Use `embedded=true` when the Inspector is hosted inside another UI, such as an iframe.
|
|
|
|
```text
|
|
/?embedded=true
|
|
```
|
|
|
|
Use `embeddedConfig` with a URL-encoded JSON object when the embedded host needs styling overrides.
|
|
|
|
```json
|
|
{
|
|
"backgroundColor": "#f5f5f5",
|
|
"padding": "16px"
|
|
}
|
|
```
|
|
|
|
## Example links
|
|
|
|
Open the hosted Inspector and connect to a server:
|
|
|
|
```text
|
|
https://inspector.mcp-use.com/inspect?autoConnect=https://your-server.com/mcp
|
|
```
|
|
|
|
Open the hosted Inspector, connect to a server, and show Tools:
|
|
|
|
```text
|
|
https://inspector.mcp-use.com/inspect?server=https://your-server.com/mcp&tab=tools
|
|
```
|