Nuxt UI MCP Server

This project implements a Model Context Protocol (MCP) server for Nuxt UI, exposing Nuxt UI documentation and resources via a standardized API. It is built with TypeScript and Express, and leverages the @modelcontextprotocol/sdk.

Table of Contents

- Nuxt UI MCP Server
- Table of Contents
- Features
- Prerequisites
- Installation
- 1. Clone the repository:
- 2. Install dependencies:
- Running the Server
- Build
- Start (Foreground)
- Start (Background with PM2)
- Stop (Background/PM2)
- Delete PM2 Process
- View PM2 Logs
- Development Mode
- Environment Variables
- Testing
- Contributing
- License

Features

- Serves Nuxt UI documentation and resources via MCP endpoints
- Express-based HTTP server
- Supports session-based streaming via MCP

Prerequisites

- Node.js v18 or higher
- npm v9 or higher

Installation

1. Clone the repository:

   git clone <your-fork-or-repo-url>
   cd nuxt-ui-mcp
   

2. Install dependencies:

   npm install
   

Running the Server

Build

First, compile the TypeScript source:

npm run build

Start (Foreground)

npm start

Start (Background with PM2)

npm run start:bg

Stop (Background/PM2)

npm run stop:bg

Delete PM2 Process

npm run delete:bg

View PM2 Logs

npm run logs:bg

Development Mode

Runs the server and the MCP inspector concurrently:

npm run dev

The server will listen on the port specified by the DEFAULT_PORT environment variable, or 3000 if not set.

Environment Variables

Create a .env file in the project root if you need to override defaults. Example:

DEFAULT_PORT=3000

Testing

There are currently no automated tests or test scripts for this project. If you would like to contribute tests, see the Contributing section.

Contributing

1. Fork this repository and create a new branch for your feature or fix.
2. Ensure you have Node.js and npm installed.
3. Run npm install to install dependencies.
4. Use npm run build to compile TypeScript before submitting a PR.
5. Follow the existing code style and TypeScript strictness (see tsconfig.json).
6. If adding features or fixing bugs, please document your changes in the PR description.

License

MIT