https://github.com/epicweb-dev/mcp-ui
https://github.com/epicweb-dev/mcp-ui
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/epicweb-dev/mcp-ui
- Owner: epicweb-dev
- License: other
- Created: 2025-08-15T21:57:07.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-09-11T23:53:17.000Z (8 months ago)
- Last Synced: 2025-09-12T01:56:54.231Z (8 months ago)
- Language: TypeScript
- Homepage: https://mcp-ui.epicai.pro/
- Size: 3.05 MB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
MCP UI 🪟
Go beyond text interaction in AI Chat
MCP UI is a sub-spec of the MCP protocol that allows servers to send UI along with their responses enabling supporting clients to offer even better user experiences.
[![Build Status][build-badge]][build]
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
## Prerequisites
- JavaScript/TypeScript experience
- Node.js experience
- [Advanced MCP Features](https://www.epicai.pro/advanced-mcp-features) or
equivalent experience.
## Pre-workshop Resources
Here are some resources you can read before taking the workshop to get you up to
speed on some of the tools and concepts we'll be covering:
- [Letting AI Interface with Your App with MCPs](https://www.epicai.pro/letting-ai-interface-with-your-app-with-mcps-talk)
- [MCP Introduction](https://modelcontextprotocol.io/introduction)
- [Your AI Assistant Instructor: The EpicShop MCP Server](https://www.epicai.pro/your-ai-assistant-instructor-the-epicshop-mcp-server-0eazr)
- [How to Debug Your MCP Server](https://www.epicai.pro/how-to-debug-your-mcp-server-38qyl)
## System Requirements
- [git][git] v2.18 or greater
- [NodeJS][node] v18 or greater
- [npm][npm] v8 or greater
All of these must be available in your `PATH`. To verify things are set up
properly, you can run this:
```shell
git --version
node --version
npm --version
```
If you have trouble with any of these, learn more about the PATH environment
variable and how to fix it here for [windows][win-path] or
[mac/linux][mac-path].
## Setup
This is a pretty large project (it's actually many apps in one) so it can take
several minutes to get everything set up the first time. Please have a strong
network connection before running the setup and grab a snack.
> **Warning**: This repo is _very_ large. Make sure you have a good internet
> connection before you start the setup process. The instructions below use
> `--depth` to limit the amount you download, but if you have a slow connection,
> or you pay for bandwidth, you may want to find a place with a better
> connection.
Follow these steps to get this set up:
```sh nonumber
git clone --depth 1 https://github.com/epicweb-dev/mcp-ui.git
cd mcp-ui
npm run setup
```
If you experience errors here, please open [an issue][issue] with as many
details as you can offer.
## The Workshop App
Learn all about the workshop app on the
[Epic Web Getting Started Guide](https://www.epicweb.dev/get-started).
[](https://www.epicweb.dev/get-started)
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
[git]: https://git-scm.com/
[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/mcp-ui/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/epicweb-dev/mcp-ui/actions?query=workflow%3Avalidate
[license-badge]: https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square
[license]: https://github.com/epicweb-dev/mcp-ui/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://kentcdodds.com/conduct
[win-path]: https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/
[mac-path]: http://stackoverflow.com/a/24322978/971592
[issue]: https://github.com/epicweb-dev/mcp-ui/issues/new