mcp-use__mcp-use/examples/README.md

# Examples

This directory contains examples for both Python and TypeScript implementations of mcp-use.

## Templates — ready-to-deploy example apps

If you're looking for **full example apps** you can deploy in one click (Chart Builder, Diagram Builder, Slide Deck, Maps Explorer, Widget Gallery, and more), see the dedicated **[Templates gallery](https://github.com/mcp-use/mcp-use#templates)** in the main README — or browse the [Templates page in the docs](https://docs.mcp-use.com/v2/typescript/getting-started/templates). Each template lives in its own repo with a live demo URL and a one-click deploy button.

The examples below are **in-repo code samples** meant to illustrate specific APIs and patterns — not deployable apps.

## Quick Links

- **[Python Examples](../libraries/python/examples/)** - Python client, server, and agent examples
- **[TypeScript Examples](../libraries/typescript/packages/client/examples/)** - TypeScript/JavaScript examples (see also [agent](../libraries/typescript/packages/agent/examples/) and [server](../libraries/typescript/packages/server/examples/))

## Local Development

When you clone this repository locally, you'll find `python/` and `typescript/` subdirectories here that are symbolic links to the actual example directories. These symlinks make it convenient to access examples from the repository root.

## Python Examples

### Client Examples
- **[HTTP Example](../libraries/python/examples/http_example.py)** - Basic HTTP client usage
- **[Stream Example](../libraries/python/examples/stream_example.py)** - Streaming responses
- **[Code Mode Example](../libraries/python/examples/code_mode_example.py)** - Code mode execution
- **[Direct Tool Call](../libraries/python/examples/direct_tool_call.py)** - Direct tool invocation
- **[Multi-Server Example](../libraries/python/examples/multi_server_example.py)** - Working with multiple servers

### Server Examples
- **[Basic Server](../libraries/python/examples/server/server_example.py)** - Simple server implementation
- **[Middleware Example](../libraries/python/examples/server/middleware_example.py)** - Server middleware
- **[Context Example](../libraries/python/examples/server/context_example.py)** - Server context usage
- **[OAuth Example](../libraries/python/examples/simple_oauth_example.py)** - OAuth authentication
- **[OAuth Dynamic Client Registration](../libraries/python/examples/client/oauth_dynamic_client_registration.py)** - RFC 7591 dynamic client registration
- **[OAuth Preregistered Client](../libraries/python/examples/client/oauth_preregistered.py)** - Using a preregistered OAuth client
- **[Client Middleware Example](../libraries/python/examples/example_middleware.py)** - Client-side middleware pipeline
- **[Sandbox Everything](../libraries/python/examples/sandbox_everything.py)** - E2B sandbox all MCP features
- **[Server Manager](../libraries/python/examples/simple_server_manager_use.py)** - Dynamic multi-server management

### Agent Examples
- **[Chat Example](../libraries/python/examples/chat_example.py)** - Basic chat agent
- **[MCP Everything](../libraries/python/examples/mcp_everything.py)** - Comprehensive MCP usage
- **[Structured Output](../libraries/python/examples/structured_output.py)** - Structured responses
- **[Limited Memory Chat](../libraries/python/examples/limited_memory_chat.py)** - Memory management
- **[Multimodal Input](../libraries/python/examples/multimodal_input_example.py)** - Multimodal processing

### Integration Examples
- **[OpenAI Integration](../libraries/python/examples/openai_integration_example.py)** - OpenAI API integration
- **[Anthropic Integration](../libraries/python/examples/anthropic_integration_example.py)** - Anthropic API integration
- **[LangChain Integration](../libraries/python/examples/langchain_integration_example.py)** - LangChain integration
- **[Google Integration](../libraries/python/examples/google_integration_example.py)** - Google API integration

### MCP Server Integrations
- **[Airbnb MCP](../libraries/python/examples/airbnb_use.py)** - Airbnb integration
- **[Blender Use](../libraries/python/examples/blender_use.py)** - Blender integration
- **[Browser Use](../libraries/python/examples/browser_use.py)** - Browser automation
- **[Filesystem Use](../libraries/python/examples/filesystem_use.py)** - Filesystem operations

## TypeScript Examples

### Client Examples
- **[CommonJS Example](../libraries/typescript/packages/client/examples/browser/commonjs/commonjs_example.cjs)** - CommonJS usage
- **[CLI Examples](../libraries/typescript/packages/client/examples/cli/)** - Command-line interface examples
- **[React Integration](../libraries/typescript/packages/client/examples/browser/react/)** - React client examples
- **[Notifications Client](../libraries/typescript/packages/client/examples/node/communication/notification-client.ts)** - Notification handling
- **[Sampling Client](../libraries/typescript/packages/client/examples/node/communication/sampling-client.ts)** - Sampling configuration

### Server Examples
- **[Basic Server](../libraries/typescript/packages/server/examples/basic/)** - Simple server implementation
- **[Server Features](../libraries/typescript/packages/server/examples/)** - Advanced features
  - [Conformance](../libraries/typescript/packages/server/examples/conformance/) - MCP conformance test server
  - [Elicitation](../libraries/typescript/packages/server/examples/elicitation/) - Form and URL elicitation
  - [Sampling](../libraries/typescript/packages/server/examples/sampling/) - Server-initiated LLM sampling
  - [Notifications](../libraries/typescript/packages/server/examples/notifications/) - Bidirectional notifications
  - [Skills over MCP](../libraries/typescript/packages/server/examples/skills-over-mcp/) - Publish Agent Skills and supporting files
  - [Middleware](../libraries/typescript/packages/server/examples/middleware/) - Built-in middleware pipeline
  - [Proxy](../libraries/typescript/packages/server/examples/proxy/) - Proxy MCP server
- **[OAuth Examples](../libraries/typescript/packages/server/examples/auth/)** - OAuth implementations
  - [Auth0](../libraries/typescript/packages/server/examples/auth/auth0/)
  - [Better Auth (v2 + Hono)](../libraries/typescript/packages/server/examples/auth/better-auth/)
  - [Supabase](../libraries/typescript/packages/server/examples/auth/supabase/)
  - [WorkOS](../libraries/typescript/packages/server/examples/auth/workos/)
- **[MCP Apps view examples](../libraries/typescript/packages/server/examples/views/)** — current `view` API and React hooks
  - **[Basic](../libraries/typescript/packages/server/examples/views/basic/)** - Typed tool output, view tools, host context, and display modes
  - [File Upload](../libraries/typescript/packages/server/examples/views/file-upload/) - File-manager view using `useFiles`
  - [Story Writer](../libraries/typescript/packages/server/examples/views/story-writer/) - Interactive story-writing view
  - [Tic-tac-toe](../libraries/typescript/packages/server/examples/views/tic-tac-toe/) - Stateful game UI
  - [Excalidraw](../libraries/typescript/packages/server/examples/views/excalidraw/) - Canvas-based view

### Agent Examples
- **[Agent examples](../libraries/typescript/packages/agent/examples/)** — native and LangChain MCP agents
- **[Basic Examples](../libraries/typescript/packages/agent/examples/basic/)** - Basic agent patterns
  - [Chat Example](../libraries/typescript/packages/agent/examples/basic/chat_example.ts)
  - [MCP Everything](../libraries/typescript/packages/agent/examples/basic/mcp_everything.ts)
  - [Simplified Agent](../libraries/typescript/packages/agent/examples/basic/simplified_agent_example.ts)
- **[Advanced Examples](../libraries/typescript/packages/agent/examples/advanced/)** - Advanced patterns
  - [Observability](../libraries/typescript/packages/agent/examples/advanced/observability.ts)
  - [Streaming](../libraries/typescript/packages/agent/examples/advanced/stream_example.ts)
  - [Structured Output](../libraries/typescript/packages/agent/examples/advanced/structured_output.ts)
- **[Code Mode](../libraries/typescript/packages/agent/examples/code-mode/)** - Code execution
  - [Basic Code Mode](../libraries/typescript/packages/agent/examples/code-mode/code_mode_example.ts)
  - [E2B Code Mode](../libraries/typescript/packages/agent/examples/code-mode/code_mode_e2b_example.ts)
- **[Frameworks](../libraries/typescript/packages/agent/examples/frameworks/)** - Framework integrations
  - [AI SDK Example](../libraries/typescript/packages/agent/examples/frameworks/ai_sdk_example.ts)
- **[Integrations](../libraries/typescript/packages/agent/examples/integrations/)** - MCP server integrations
  - [Airbnb](../libraries/typescript/packages/agent/examples/integrations/airbnb_use.ts)
  - [Blender](../libraries/typescript/packages/agent/examples/integrations/blender_use.ts)
  - [Browser](../libraries/typescript/packages/agent/examples/integrations/browser_use.ts)
  - [Filesystem](../libraries/typescript/packages/agent/examples/integrations/filesystem_use.ts)
- **[Server Management](../libraries/typescript/packages/agent/examples/server-management/)** - Dynamic server management
  - [Add Server Tool](../libraries/typescript/packages/agent/examples/server-management/add_server_tool.ts)
  - [Multi-Server](../libraries/typescript/packages/agent/examples/server-management/multi_server_example.ts)