Mirror of https://github.com/modelcontextprotocol/ext-apps — Official repo for spec & SDK of MCP Apps protocol - standard for UIs embedded AI chatbots, served by MCP servers
  • TypeScript 76.4%
  • MDX 19.3%
  • JavaScript 4.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jonathan Hefner 0571b56fbb Add Quickstart guide for building MCP Apps
Introduces a step-by-step tutorial covering:
- Project setup with Vite and TypeScript
- Server creation with tool + resource registration
- UI development using the App SDK
- Testing with basic-host

Also updates README to link to the guide and configures
typedoc to include it in generated documentation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 14:28:55 -06:00
.github/workflows Add basic-host and basic-server-react examples 2025-12-04 14:28:27 -06:00
.husky Add basic-host and basic-server-react examples 2025-12-04 14:28:27 -06:00
docs Add Quickstart guide for building MCP Apps 2025-12-04 14:28:55 -06:00
examples Remove simple-host and simple-server examples 2025-12-04 14:28:55 -06:00
specification/draft fix: use profile parameter for MIME type instead of suffix (#75) 2025-12-04 20:28:58 +02:00
src Add basic-host and basic-server-react examples 2025-12-04 14:28:27 -06:00
.gitattributes Track package-lock.json for deterministic builds (#44) 2025-12-01 20:06:32 +00:00
.gitignore Track package-lock.json for deterministic builds (#44) 2025-12-01 20:06:32 +00:00
.prettierignore Add basic-server-vanillajs example 2025-12-04 14:28:27 -06:00
build.bun.ts npm run prettier:fix 2025-11-23 03:15:06 +00:00
CONTRIBUTING.md setup ci & presubmit (#20) 2025-11-25 02:40:48 +00:00
package-lock.json Remove simple-host and simple-server examples 2025-12-04 14:28:55 -06:00
package.json Add basic-server-vanillajs example 2025-12-04 14:28:27 -06:00
README.md Add Quickstart guide for building MCP Apps 2025-12-04 14:28:55 -06:00
tsconfig.json Initial commit 2025-11-21 11:56:27 +00:00
typedoc.json Add Quickstart guide for building MCP Apps 2025-12-04 14:28:55 -06:00

@modelcontextprotocol/ext-apps

API Documentation

This repo contains the SDK and specification for MCP Apps Extension (SEP-1865).

MCP Apps are a proposed standard inspired by MCP-UI and OpenAI's Apps SDK to allow MCP Servers to display interactive UI elements in conversational MCP clients / chatbots.

Overview

This SDK serves two audiences:

App Developers

Build interactive UIs that run inside MCP-enabled chat clients.

  • SDK for Apps: @modelcontextprotocol/ext-apps — API Docs
  • React hooks: @modelcontextprotocol/ext-apps/react — API Docs

Host Developers

Embed and communicate with MCP Apps in your chat application.

  • SDK for Hosts: @modelcontextprotocol/ext-apps/app-bridge — API Docs

There's no supported host implementation in this repo (beyond the examples/basic-host example).

We have contributed a tentative implementation of hosting / iframing / sandboxing logic to the MCP-UI repository, and expect OSS clients may use it, while other clients might roll their own hosting logic.

Installation

This repo is in flux and isn't published to npm yet. When it is, it will use the @modelcontextprotocol/ext-apps package.

In the meantime you can depend on the SDK library in a Node.js project by installing it with its git URL:

npm install -S git+https://github.com/modelcontextprotocol/ext-apps.git

Your package.json will then look like:

{
  "dependencies": {
    "@modelcontextprotocol/ext-apps": "git+https://github.com/modelcontextprotocol/ext-apps.git"
  }
}

Note

The build tools (esbuild, tsx, typescript) are in dependencies rather than devDependencies. This is intentional: it allows the prepare script to run when the package is installed from git, since npm doesn't install devDependencies for git dependencies.

Once the package is published to npm with pre-built dist/, these can be moved back to devDependencies.

Examples

To run the examples end-to-end:

npm i
npm run examples:start

Then open http://localhost:8080/

Resources