An open API service indexing awesome lists of open source software.

https://github.com/peterbud/nitro-mcp-server

MCP (Model Context Protocol) server powered by Nitro
https://github.com/peterbud/nitro-mcp-server

mcp mcpserver nitro streamable-http

Last synced: 5 months ago
JSON representation

MCP (Model Context Protocol) server powered by Nitro

Awesome Lists containing this project

README

          

# Nitro MCP Server

This project is an MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server using **streamable HTTP** transport powered by the [Nitro](https://nitro.build/). It is designed to demonstrate how to implement an MCP Server including authentication using pluggable providers.

## Features
- Lightweight and fast, built on [Nitro](https://nitro.build/)
- Tools located at `/tools`
- Input and output schema validation with [Zod](https://zod.dev/)
- Example tools included:
- `echo`: Echoes back the input, demonstrating basic tool functionality
- `getPostsByUser`: Fetches posts by a user using an API, demonstrating output schema validation and `structuredContent`
- Example resources included:
- `posts`: Fetches posts from an API, demonstrating resource handling
- `users`: Fetches users from an API, demonstrating resource handling
- Easy integration with MCP clients
- Authentication support with pluggable providers (Auth0, Microsoft Entra ID)

## Getting Started

### Prerequisites
- Node.js (v20 or higher recommended)
- pnpm (see [pnpm installation guide](https://pnpm.io/installation))

### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/nitro-mcp-server.git
cd nitro-mcp-server
```
2. Install dependencies:
```bash
pnpm install
```

### Running the Server
Start the server with:
```bash
pnpm dev
```

Running the MCP inspector:
```bash
pnpm inspect
```

1. Open your browser and navigate to the inspector URL like `http://localhost:6274/?MCP_PROXY_AUTH_TOKEN=` to access the MCP inspector.
2. Enter the address and port of your server at the URL field, like `http://localhost:3000/mcp`.
3. Click "Connect" to establish a connection to your MCP Server.
4. You can list the tools and invoke them.

### Building the server

To build the server for production, run:
```bash
pnpm build
```
This will create a production-ready build in the `.output` directory.

## Configuration
Configuration options can be set in the `.env` file. Options include:
- `NITRO_MCP_SERVER_HOST`: The host the server listens on (default: `localhost`)
- `NITRO_MCP_SERVER_PORT`: The port the server listens on (default: 3000)

## Authentication
Authentication is supported via pluggable providers. Currently, Auth0 and Microsoft Entra ID are available. You can enable authentication by configuring the provider in your server settings or your local `.env` file in development.

As many Identity Providers do not support Dynamic Client Registration (DCR), this application uses an oAuth proxy solution to provide DCR as MCP specification requires, but delegates all the authentication responsibilities to the Identity Provider. Please note as such apply appropriate rate limiting to prevent misuse of `register` endpoint.

### Supported Providers
- **Auth0**: Configure with your Auth0 domain, client ID, and client secret.
- **Entra (Microsoft Entra ID)**: Configure with your tenant ID, client ID, and client secret.

Example configuration:
```js
mcpServer: {
auth: {
providers: {
auth0: {
type: 'auth0',
domain: '',
clientId: '',
clientSecret: '',
scope: 'openid profile email',
},
entra: {
type: 'entra',
tenantId: '',
clientId: '',
clientSecret: '',
scope: 'openid profile email',
}
}
}
}
```

These settings are configurable in an `.env' file or directly in the development environment, and at the server configuration in production. See the [env.example](env.example) file for a template.

See the provider files in `lib/auth/` for more details and advanced options.

## Todo

- Add cleanup task for expired authorization codes

## Contributing
Pull requests and issues are welcome! Please open an issue to discuss your ideas or report bugs.

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.