Implements OAuth authentication by delegating authorization to Auth0, allowing secure user authentication and authorization for MCP clients without requiring manual client registration.
Provides Docker support for running and testing the MCP server with the Model Context Protocol inspector tool.
Supports environment variable configuration through .env files for easy server setup and configuration.
Mentioned as a potential third-party authorization server that the OAuth Proxy can delegate to, enabling user authentication through GitHub credentials.
Mentioned as a potential third-party authorization server that the OAuth Proxy can delegate to, enabling user authentication through Google credentials.
Leverages npm for package management and running scripts for development and testing.
Built with TypeScript, providing type safety and modern JavaScript features for the MCP server implementation.
MCP Server Boilerplate
A comprehensive Model Context Protocol (MCP) server boilerplate built with TypeScript and Streamable HTTP transport with an OAuth Proxy for 3rd party authorization servers like Auth0.
Features
- MCP Server implementation: HTTP-Based Streamable transport using
@modelcontextprotocol/sdk
with HTTP transport, session management, and tool execution. - OAuth authentication/3rd party authorization: Implements an OAuth server for MCP clients to process 3rd party authorization servers like Auth0, providing Dynamic Application Registration for MCP server.
- Storage: Provide storage for MCP server to store data like OAuth sessions, tokens, etc.
- Built-in sample tools:
echo
,system-time
,project
for demonstration.
Why this project exists?
- The Model Context Protocol spec requires Dynamic Application Registration because it provides a standardized way for MCP clients to automatically register with new servers and obtain OAuth client IDs without user interaction. The main reason for this mechanism is because MCP clients can't know all possible services in advance and manual registration would create significant effort for users and it is not scalable. If do not support Dynamic Application Registration, then MCP clients need to provide OAuth client ID and secret to the server, which is not secure and not scalable.
- However, enabling Dynamic Application Registration (if supported) becomes a security risk because the endpoint is a public endpoint that anyone can create OAuth clients. It can easily be abused, such as by flooding with unwanted client registrations. Hence, Auth0 has disabled Dynamic Application Registration
- As a result, this project provides a way to enable Dynamic Application Registration for MCP server by using OAuth Proxy, but delegating authorization to 3rd party authorization server like Auth0, Github, Google, etc.
Endpoints
Endpoint | Description |
---|---|
GET /ping | Ping the server |
POST /mcp | MCP protocol request with authentication |
DELETE /mcp | Session termination |
GET /.well-known/oauth-authorization-server | OAuth authorization server metadata |
GET /.well-known/oauth-protected-resource | OAuth protected resources metadata |
POST /oauth/register | Register a new MCP client |
GET /oauth/authorize | Handle authorization request |
POST /oauth/token | Handle token request |
POST /oauth/revoke | Handle token revocation |
GET /oauth/stats | Get OAuth service statistics |
GET /oauth/auth0-callback | Handle Auth0 callback |
Getting Started
Installation
- Clone the repository:
- Install dependencies:
- Set up environment variables:
- Set up the MCP server for local development
Set up the MCP server for Cursor
- Create MCP configuration file for local buildCreate a
.cursor/mcp.json
file in your project directory (for project-specific setup) or~/.cursor/mcp.json
in your home directory (for global setup):
Use npx @modelcontextprotocol/inspector
to test the MCP server
- Copy
mcp-config.example.json
tomcp-config.json
- Edit
mcp-config.json
to point to the correct MCP server - Run the inspectoror
Setup Auth0 for authorization
- Create a new application in Auth0
- Go to Auth0 Dashboard
- Click on "Applications"
- Click on "Create Application"
- Name: MCP Server Boilerplate
- Application Type: Regular Web Application
- Click on "Create"
- Set up the application
- Click on "Settings"
- Set the following settings:
- Allowed Callback URLs:
http://localhost:3000/oauth/auth0-callback
- Allowed Web Origins:
http://localhost:3000
- Allowed Callback URLs:
- Create a new API
- Click on "APIs"
- Click on "Create API"
- Name: MCP Server Boilerplate
- Identifier:
urn:mcp-server-boilerplate
- JSON Web Token (JWT) Profile: Auth0
- JSON Web Token (JWT) Signature Algorithm: RS256
- Click on "Create"
Screenshots
Metadata Discovery | Client Registration | Preparing Authorization |
---|---|---|
Authorization with 3rd party server | Request Authorization and acquire authorization code | Token Request and Authentication Complete |
---|---|---|
References
This server cannot be installed
A comprehensive Model Context Protocol server template that implements HTTP-based transport with OAuth proxy for third-party authorization servers like Auth0, enabling AI tools to securely connect while supporting Dynamic Application Registration.
Related MCP Servers
- AsecurityFlicenseAqualityA TypeScript-based template for developing Model Context Protocol servers with features like dependency injection and service-based architecture, facilitating the creation and integration of custom data processing tools.Last updated -12TypeScript
- -securityFlicense-qualityA Model Context Protocol server that requires user authentication via Auth0 before enabling secure API access on behalf of the authenticated user.Last updated -TypeScript
- -securityAlicense-qualityA server that implements the Model Context Protocol, providing a standardized way to connect AI models to different data sources and tools.Last updated -35TypeScriptMIT License
- -security-license-qualityA Model Context Protocol server that supports remote connections and authenticates users via GitHub OAuth, allowing them to access tools based on their GitHub identity.Last updated -TypeScript