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 d511eab059 Fix broken API documentation links in README
Update all API doc links to use correct paths:
- Add missing /api/ path segment (TypeDoc outputs to docs/api/)
- Fix module names to match actual generated files

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-27 16:35:06 -06:00
.github/workflows Add API docs (#29) 2025-11-27 22:09:22 +00:00
.husky setup ci & presubmit (#20) 2025-11-25 02:40:48 +00:00
docs Add API docs (#29) 2025-11-27 22:09:22 +00:00
examples build: use workspaces for example subfolders (#23) 2025-11-25 03:14:14 +00:00
specification/draft fix: use camelCase for CSP domain fields in specification 2025-11-27 16:48:07 +00:00
src Add API docs (#29) 2025-11-27 22:09:22 +00:00
.gitignore Add API docs (#29) 2025-11-27 22:09:22 +00: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.json Add API docs (#29) 2025-11-27 22:09:22 +00:00
README.md Fix broken API documentation links in README 2025-11-27 16:35:06 -06:00
tsconfig.json Initial commit 2025-11-21 11:56:27 +00:00
typedoc.json Add API docs (#29) 2025-11-27 22:09:22 +00: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/simple-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 start

Then open http://localhost:8080/

Resources