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
133 lines
3.9 KiB
Plaintext
133 lines
3.9 KiB
Plaintext
---
|
|
title: "CLI Usage"
|
|
description: "Run the MCP Inspector from the command line"
|
|
icon: "terminal"
|
|
---
|
|
|
|
{/* TODO: Add Inspector media when a screenshot or short clip would clarify the workflow. */}
|
|
|
|
The MCP Inspector can be run directly from the command line using `npx`, making it easy to quickly inspect and debug MCP servers without installing anything globally.
|
|
|
|
## Quick Start
|
|
|
|
Run the inspector with a single command:
|
|
|
|
```bash
|
|
npx @mcp-use/inspector
|
|
```
|
|
|
|
This will:
|
|
- Start the inspector server on an available port (default: 8080)
|
|
- Automatically open your browser to the inspector interface
|
|
- Display the URL in the terminal
|
|
|
|
## Command Options
|
|
|
|
### `--url <url>`
|
|
|
|
Auto-connect to an MCP server when the inspector starts.
|
|
|
|
```bash
|
|
npx @mcp-use/inspector --url http://localhost:3000/mcp
|
|
```
|
|
|
|
### `--port <port>`
|
|
|
|
Specify the starting port number. The inspector will find the next available port if the specified port is already in use.
|
|
|
|
```bash
|
|
npx @mcp-use/inspector --port 9000
|
|
```
|
|
|
|
**Default:** `8080`
|
|
|
|
**Port Range:** Must be between 1 and 65535
|
|
|
|
### `--no-open`
|
|
|
|
Prevent the inspector from automatically opening a browser tab when it starts. Useful in CI/CD pipelines, headless environments, or when you prefer to open the URL manually.
|
|
|
|
```bash
|
|
npx @mcp-use/inspector --no-open
|
|
```
|
|
|
|
You can combine it with other flags:
|
|
|
|
```bash
|
|
npx @mcp-use/inspector --url http://localhost:3000/mcp --port 9000 --no-open
|
|
```
|
|
|
|
### `--help, -h`
|
|
|
|
Display help information and available options.
|
|
|
|
```bash
|
|
npx @mcp-use/inspector --help
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
### `MCP_INSPECTOR_FRAME_ANCESTORS`
|
|
|
|
Configure which origins can embed the inspector widget in iframes. This is useful when embedding the inspector into your own application or when testing widgets from different domains.
|
|
|
|
**Default behavior:**
|
|
- **Development mode**: `*` (allows all origins for easier development)
|
|
- **Production mode**: `'self'` (same-origin only for security)
|
|
|
|
**Format:** Space-separated list of origins or `*` for all origins
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Allow embedding from specific domains
|
|
MCP_INSPECTOR_FRAME_ANCESTORS="https://app.example.com https://dev.example.com" npx @mcp-use/inspector
|
|
|
|
# Allow embedding from any domain (useful for development)
|
|
MCP_INSPECTOR_FRAME_ANCESTORS="*" npx @mcp-use/inspector
|
|
|
|
# Multiple origins with wildcards
|
|
MCP_INSPECTOR_FRAME_ANCESTORS="https://*.example.com http://localhost:*" npx @mcp-use/inspector
|
|
```
|
|
|
|
<Note>
|
|
In production deployments, it's recommended to explicitly list allowed origins rather than using `*` to prevent unauthorized embedding.
|
|
</Note>
|
|
|
|
<Tip>
|
|
When running in development mode (`npm run dev`), the inspector automatically allows all origins by default, so you don't need to set this variable unless you want to test production CSP policies.
|
|
</Tip>
|
|
|
|
### `MCP_URL`
|
|
|
|
Set the external base URL for your MCP server. This is useful when running behind a reverse proxy (ngrok, E2B sandboxes, Cloudflare tunnels) where the public URL differs from `localhost`.
|
|
|
|
When set, the CLI will use this URL for widget asset URLs and Vite HMR WebSocket connections, ensuring everything works correctly through the proxy.
|
|
|
|
**Default behavior:**
|
|
- If not set, the CLI generates a `localhost` URL automatically
|
|
- If set, the CLI preserves your value and does not overwrite it
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# ngrok tunnel
|
|
MCP_URL=https://abc123.ngrok.io npx @mcp-use/cli dev
|
|
|
|
# E2B sandbox
|
|
MCP_URL=https://3000-abc123.e2b.app npx @mcp-use/cli dev
|
|
|
|
# Cloudflare tunnel
|
|
MCP_URL=https://my-tunnel.trycloudflare.com npx @mcp-use/cli dev
|
|
```
|
|
|
|
<Tip>
|
|
When using a reverse proxy, set `MCP_URL` to the public-facing URL. This ensures widget hot-reload (HMR) and asset loading work correctly through the proxy.
|
|
</Tip>
|
|
|
|
## Related Documentation
|
|
|
|
- [Getting Started](/inspector/index) - Overview of the inspector
|
|
- [Connection Settings](/inspector/connection-settings) - Advanced connection configuration
|
|
- [Mount the Inspector](/inspector/integration) - Serve the Inspector from an app
|