Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

typescript-server-demo

This barebones server demonstrates how to use @mcp-ui/server to generate all three types of UI resources via three separate tools:

  • showExternalUrl: Renders an <iframe> pointing to an external URL.
  • showRawHtml: Renders a static block of HTML.
  • showRemoteDom: Executes a script that uses a custom component (<ui-text>) to render content, demonstrating how to leverage a client-side component library.

For a detailed explanation of how this server works, see the TypeScript Server Walkthrough.

Running the server

To run the server in development mode, first install the dependencies, then run the dev command:

pnpm install
pnpm dev

The server will be available at http://localhost:3000.

You can view the UI resources from this server by connecting to it with the ui-inspector (target http://localhost:3000/mcp with Streamable HTTP Transport Type).