About Nuxt UI MCP Server
Nuxt UI MCP Server makes Nuxt UI documentation and resources available to MCP clients. It uses Express for HTTP serving and supports session-based MCP streaming.
Key features
- 01Serve Nuxt UI docs and resources through MCP endpoints
- 02Express-based HTTP server
- 03Session-based MCP streaming
Use cases
- 01Access Nuxt UI documentation from an MCP client
- 02Stream MCP content within a session
MCP support
The MCP server exposes Nuxt UI documentation and resources to MCP clients through standardized endpoints, with support for session-based streaming.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
We haven’t collected a package or remote endpoint for this server. Follow the instructions in the project README.
Tools
Local servers expose tools only once running on your machine, and the maintainer has not provided a tool list.
Details
From the project READMENuxt 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
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
- Fork this repository and create a new branch for your feature or fix.
- Ensure you have Node.js and npm installed.
- Run
npm installto install dependencies. - Use
npm run buildto compile TypeScript before submitting a PR. - Follow the existing code style and TypeScript strictness (see
tsconfig.json). - If adding features or fixing bugs, please document your changes in the PR description.
License
MIT
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.