GitHub Style Markdown Preview MCP App

This MCP server enables GitHub Flavored Markdown previews within MCP apps, allowing you to render and preview Markdown content with GitHub-style styling directly in your client integrations.

How to use

You can build and run the MCP App locally, then connect your MCP client to the server path at /mcp. Use the provided commands to build the UI, start the server, or run in watch mode for development. You can also tunnel the local server to expose it for external connectors like Claude.

How to install

Prerequisites you need before you begin are Node.js and npm, plus optional tools for exposing your local server externally (for example a tunnel utility). Follow these steps to set up and run the MCP server.

Clone the repository (replace with the actual URL of your project):

git clone <repository-url>

Navigate to the project directory:

cd <project-directory>

Install dependencies:

npm install

Build the UI and server:

npm run build

Start the server locally (serves at http://localhost:3001/mcp):

npm run serve

Optionally, run with watch mode during development:

npm run dev

To expose the local server for external tooling, you can start a tunnel and then connect the external client using the provided URL path:

npx cloudflared tunnel --url http://localhost:3001

After the tunnel starts, copy the generated URL (for example, https://random-name.trycloudflare.com) and point your external connector to:

https://<your-url>.trycloudflare.com/mcp

## Additional notes

The MCP server includes client and server components for rendering Markdown with GitHub Flavored Markdown support. The project structure includes a React-based UI, a Markdown renderer with GFM support, and a server entry point that handles the MCP transport. Ensure you have the required environment set up for TypeScript development and that you run the build step prior to serving in production mode.