example-remote

This MCP server, example-remote, implements the full Model Context Protocol stack with in-process OAuth2 authentication and in-memory session management. It exposes a rich set of MCP features including tools (7 example tools with capabilities such as echo, add, long-running operations, and LLM sampling), resources (100+ example resources with pagination and subscription support), prompts (simple and complex prompts with argument support), and sampling (LLM interaction). It also includes elicitation for user input and supports both Streamable HTTP and SSE transports. To explore the server, install dependencies, start in development mode, and connect the MCP Inspector to the server URL (http://localhost:3232/mcp) to authenticate and inspect the available endpoints and capabilities. The server can operate with internal (in-process) OAuth endpoints for rapid experimentation or external auth in production-like setups when you want to separate authorization from resource access.

Prerequisites:

• Node.js >= 16
• npm or yarn
• Git

Install and run locally:

1. Clone the repository git clone https://github.com/modelcontextprotocol/example-remote-server.git
2. Enter the project directory cd example-remote-server
3. Install dependencies npm install
4. Start in development mode (internal auth in-process) npm run dev:internal

Optional for production-like testing:

• Build and run with external auth npm run build npm run start:external

To verify Redis-backed sessions (optional):

• Start Redis (e.g., via Docker Compose) docker compose up -d
• Run server with Redis configuration REDIS_URL=redis://localhost:6379 npm run dev:internal

Notes and tips:

• The server supports two authentication modes: internal (in-process OAuth) and external (separate auth server). By default, the Quick Start uses internal mode for simplicity.
• Configuration is controlled by environment variables or an .env file (.env.example is provided in the repo). To customize, copy .env.example to .env and edit values such as AUTH_MODE and REDIS_URL.
• If you plan to scale beyond a single instance, consider enabling Redis-backed session storage by following the Redis setup steps in the Documentation section and configuring REDIS_URL accordingly.
• The MCP Inspector can be launched with npx -y @modelcontextprotocol/inspector to explore and authenticate against the running server. Ensure the server is reachable at http://localhost:3232/mcp when testing the inspector.