[LG-5666] MCP-UI App Scaffolding #3280
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # next.js | ||
| /.next/ | ||
| /out/ | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| *.pem | ||
|
|
||
| # debug | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # local env files | ||
| .env*.local | ||
| .env.local | ||
|
|
||
| # vercel | ||
| .vercel | ||
|
|
||
| # typescript | ||
| *.tsbuildinfo | ||
| next-env.d.ts | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # MCP UI App | ||
|
|
||
| A Next.js application for the MCP UI, configured for iframe embedding with CORS and CSP headers. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### 1. Environment Setup | ||
|
|
||
| Create a `.env.local` file in the app root with the following variables: | ||
|
|
||
| ```bash | ||
| # Base URL for the application | ||
| NEXT_PUBLIC_BASE_URL=http://localhost:3000 | ||
|
|
||
| # Allowed parent origins for iframe embedding (comma-separated) | ||
| ALLOWED_IFRAME_ORIGINS=http://localhost:3000,http://localhost:3001,https://your-app.com | ||
| ``` | ||
|
|
||
| Configuration options: | ||
|
|
||
| - `NEXT_PUBLIC_BASE_URL`: The base URL of your application | ||
| - `ALLOWED_IFRAME_ORIGINS`: Comma-separated list of allowed parent origins for iframe embedding | ||
|
|
||
| ### 2. Install dependencies | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ### 3. Run the development server | ||
|
|
||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Base URL | ||
|
|
||
| The base URL is configured via the `NEXT_PUBLIC_BASE_URL` environment variable and can be accessed in your code: | ||
|
|
||
| ```typescript | ||
| import config from '@/config'; | ||
|
|
||
| console.log(config.baseUrl); // http://localhost:3000 | ||
| ``` | ||
|
|
||
| ### CORS and Iframe Embedding | ||
|
|
||
| The app is configured with: | ||
|
|
||
| - **CORS headers**: Allow cross-origin requests from specified origins | ||
| - **CSP headers**: Content Security Policy appropriate for iframe embedding | ||
| - **Frame ancestors**: Controls which domains can embed this app in an iframe | ||
|
|
||
| To allow your app to be embedded in an iframe from specific domains, add them to the `ALLOWED_IFRAME_ORIGINS` environment variable. | ||
|
|
||
| ## Build | ||
|
|
||
| This app is excluded from the default `pnpm build` command in the workspace. To build this app specifically, run: | ||
|
|
||
| ```bash | ||
| cd apps/mcp-ui-app | ||
| pnpm build | ||
| ``` | ||
|
|
||
| Or from the workspace root: | ||
|
|
||
| ```bash | ||
| pnpm build:apps | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /** @type {import('next').NextConfig} */ | ||
| const nextConfig = { | ||
| reactStrictMode: true, | ||
| transpilePackages: [ | ||
| '@lg-mcp-ui/list-databases', | ||
| '@leafygreen-ui/card', | ||
| '@leafygreen-ui/typography', | ||
| '@leafygreen-ui/emotion', | ||
| '@leafygreen-ui/tokens', | ||
| '@leafygreen-ui/lib', | ||
| ], | ||
|
|
||
| async headers() { | ||
| // Get allowed origins from environment variable | ||
| const allowedOrigins = process.env.ALLOWED_IFRAME_ORIGINS?.split(',') || [ | ||
| '*', | ||
| ]; | ||
|
|
||
| return [ | ||
| { | ||
| // Apply to all routes | ||
| source: '/:path*', | ||
| headers: [ | ||
| // CORS headers for iframe embedding | ||
| { | ||
| key: 'Access-Control-Allow-Origin', | ||
| value: allowedOrigins[0] || '*', // Use first origin or wildcard | ||
| }, | ||
| { | ||
| key: 'Access-Control-Allow-Methods', | ||
| value: 'GET, POST, PUT, DELETE, OPTIONS', | ||
| }, | ||
| { | ||
| key: 'Access-Control-Allow-Headers', | ||
| value: 'Content-Type, Authorization', | ||
| }, | ||
| { | ||
| key: 'Access-Control-Allow-Credentials', | ||
| value: 'true', | ||
| }, | ||
| // Content Security Policy for iframe embedding | ||
| { | ||
| key: 'Content-Security-Policy', | ||
| value: [ | ||
| "default-src 'self'", | ||
| "script-src 'self' 'unsafe-eval' 'unsafe-inline'", | ||
TheSonOfThomp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "style-src 'self' 'unsafe-inline'", | ||
| "img-src 'self' data: https:", | ||
| "font-src 'self' data:", | ||
| "connect-src 'self'", | ||
| `frame-ancestors ${allowedOrigins.join(' ')}`, // Allows embedding in iframes from these origins | ||
| ].join('; '), | ||
| }, | ||
| ], | ||
| }, | ||
| ]; | ||
| }, | ||
| }; | ||
|
|
||
| module.exports = nextConfig; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "name": "@lg-apps/mcp-ui-app", | ||
|
Collaborator
There was a problem hiding this comment. nit: This probably doesn't need to be scoped since we're not publishing it to npm |
||
| "version": "0.1.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "dev": "next dev", | ||
| "build": "next build", | ||
|
Collaborator
There was a problem hiding this comment. Turbo is complaining that there's nothing to cache when I run this. Probable need to add a custom turbo config for the app that sets the outputs https://turborepo.com/docs/reference/configuration#outputs |
||
| "start": "next start", | ||
| "lint": "next lint" | ||
| }, | ||
| "dependencies": { | ||
| "@lg-mcp-ui/list-databases": "workspace:*", | ||
| "next": "^14.2.0", | ||
| "react": "^18.2.0", | ||
| "react-dom": "^18.2.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^20.12.5", | ||
| "@types/react": "18.2.23", | ||
| "@types/react-dom": "18.2.8", | ||
| "typescript": "~5.8.0" | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import React from 'react'; | ||
| import type { Metadata } from 'next'; | ||
|
|
||
| export const metadata: Metadata = { | ||
| title: 'MCP UI App', | ||
| description: 'MCP UI Application', | ||
| }; | ||
|
|
||
| export default function RootLayout({ | ||
| children, | ||
| }: { | ||
| children: React.ReactNode; | ||
| }) { | ||
| return ( | ||
| <html lang="en"> | ||
| <body>{children}</body> | ||
| </html> | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| 'use client'; | ||
|
|
||
| import React from 'react'; | ||
| import { ListDatabases } from '@lg-mcp-ui/list-databases'; | ||
|
|
||
| export default function ListDatabasesPage() { | ||
| return <ListDatabases databases={[]} />; | ||
| } | ||
|
Comment on lines
+1
to
+8
Collaborator
There was a problem hiding this comment. Future consideration — this could probably be a |
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would think that a benefit of keeping these different components in a monorepo is being able to centralize
.gitignorepatterns in the root.gitignorefile. Is there an explicit reason we need a separate one defined here?