Skip to content

Commit 0ebcab5

Browse files
committed
docs: add user guide with 9 MDX pages and screenshots
Adds comprehensive documentation covering McpMux concepts (Spaces, FeatureSets, Clients, Gateway, Security), getting started guide, server management, and server definition schema reference. Content is sourced by mcpmux.discover.ui at build time via fetch-docs.mjs and rendered with Fumadocs on mcpmux.com/docs. Includes GitHub Action to trigger Cloudflare Pages rebuild when docs change on main. Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
1 parent a97a133 commit 0ebcab5

8 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/guide/clients.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ McpMux works with any MCP-compatible client, including:
2323

2424
All clients connect to the same endpoint: `http://localhost:45818/mcp`
2525

26-
![Authorization Request dialog — VS Code connecting to McpMux with connection mode selection](/screenshots/clients.png)
26+
![Authorization Request dialog — VS Code connecting to McpMux with connection mode selection](https://mcpmux.com/screenshots/clients.png)
2727

2828
## Connection Modes
2929

@@ -61,7 +61,7 @@ Each client receives **FeatureSet grants** per Space. This means a single client
6161

6262
This is configured in the **Clients** page by selecting a client and managing its grants for each Space.
6363

64-
![Client detail panel — Cursor with per-Space FeatureSet grants and permission management](/screenshots/client-detail.png)
64+
![Client detail panel — Cursor with per-Space FeatureSet grants and permission management](https://mcpmux.com/screenshots/client-detail.png)
6565

6666
## Access Keys
6767

@@ -81,7 +81,7 @@ Clients can be registered in two ways:
8181
1. **Automatic** — when a new client connects to the gateway via OAuth, McpMux prompts you to approve it
8282
2. **Manual** — add a client through the McpMux UI and copy the access key into your client's configuration
8383

84-
![Effective Features view showing 45 tools, 8 prompts, and 3 resources available to Cursor](/screenshots/client-permissions.png)
84+
![Effective Features view showing 45 tools, 8 prompts, and 3 resources available to Cursor](https://mcpmux.com/screenshots/client-permissions.png)
8585

8686
### Monitoring
8787

docs/guide/feature-sets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Without permission control, every AI client connected through the gateway can ac
1515

1616
FeatureSets solve this by letting you define exactly what each client can do.
1717

18-
![FeatureSets page showing All Features, Default, Custom (Cloudflare Workers, Full Stack Dev, React Development, Read Only)](/screenshots/featuresets.png)
18+
![FeatureSets page showing All Features, Default, Custom (Cloudflare Workers, Full Stack Dev, React Development, Read Only)](https://mcpmux.com/screenshots/featuresets.png)
1919

2020
## FeatureSet Types
2121

@@ -88,7 +88,7 @@ FeatureSets can **contain other FeatureSets**. This lets you build hierarchical
8888

8989
## Managing FeatureSets
9090

91-
![React Development FeatureSet — configuring included features from each server](/screenshots/featureset-detail.png)
91+
![React Development FeatureSet — configuring included features from each server](https://mcpmux.com/screenshots/featureset-detail.png)
9292

9393
### Creating a Custom FeatureSet
9494

docs/guide/gateway.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The gateway maintains a pool of connections to backend MCP servers:
7070

7171
This means if two clients in the same Space both use the GitHub server, they share a single connection to GitHub — reducing resource usage.
7272

73-
![Dashboard showing gateway running on localhost:45818 with server stats and client configuration](/screenshots/dashboard.png)
73+
![Dashboard showing gateway running on localhost:45818 with server stats and client configuration](https://mcpmux.com/screenshots/dashboard.png)
7474

7575
## Starting and Stopping
7676

docs/guide/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ You can create additional Spaces later for different contexts:
3131

3232
To create a Space, go to the **Spaces** page and click **Create Space**.
3333

34-
![Space switcher in the sidebar lets you quickly switch between workspaces](/screenshots/space-switcher.png)
34+
![Space switcher in the sidebar lets you quickly switch between workspaces](https://mcpmux.com/screenshots/space-switcher.png)
3535

3636
## Step 3: Browse and Install a Server
3737

3838
Navigate to **Discover Servers** in McpMux or browse the [server registry](/) on this website. You'll find 100+ MCP servers for popular tools.
3939

40-
![Discover Servers page — browse, search, and install MCP servers from the registry](/screenshots/discover.png)
40+
![Discover Servers page — browse, search, and install MCP servers from the registry](https://mcpmux.com/screenshots/discover.png)
4141

4242
Click **Install** on any server to add it to your active Space. Popular choices to start with:
4343

@@ -60,7 +60,7 @@ See [Server Management](/docs/servers/) for details on all configuration options
6060

6161
Go to the **Dashboard** and click **Start Gateway**. The gateway starts on `localhost:45818` and begins connecting to your enabled servers.
6262

63-
![Dashboard with gateway running and connected servers](/screenshots/dashboard.png)
63+
![Dashboard with gateway running and connected servers](https://mcpmux.com/screenshots/dashboard.png)
6464

6565
You'll see server status indicators change:
6666
- 🟡 **Connecting** — establishing MCP handshake

docs/guide/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: What is McpMux
33
description: Configure MCP servers once, connect every AI client through a single endpoint. McpMux is a free desktop app and local gateway for MCP server management with encrypted credential storage.
44
---
55

6-
![McpMux desktop app — dashboard with gateway running, server stats, and client configuration](/screenshots/features-hero.png)
6+
![McpMux desktop app — dashboard with gateway running, server stats, and client configuration](https://mcpmux.com/screenshots/features-hero.png)
77

88
## The Problem
99

@@ -27,7 +27,7 @@ McpMux Gateway (localhost:45818/mcp)
2727
MCP Servers (GitHub, Slack, PostgreSQL, …)
2828
```
2929

30-
![McpMux dashboard showing gateway status, connected servers, FeatureSets, clients, and connection config](/screenshots/dashboard.png)
30+
![McpMux dashboard showing gateway status, connected servers, FeatureSets, clients, and connection config](https://mcpmux.com/screenshots/dashboard.png)
3131

3232
McpMux sits between your AI clients and your MCP servers. It handles:
3333

docs/guide/server-definitions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to create MCP server definitions for the McpMux registry.
55

66
A **server definition** is a JSON file that describes an MCP server — how to run it, what credentials it needs, and what capabilities it provides. Server definitions power the [McpMux server registry](/) and enable one-click installation.
77

8-
![McpMux web registry — browse and install MCP servers with one click](/screenshots/discover-web.png)
8+
![McpMux web registry — browse and install MCP servers with one click](https://mcpmux.com/screenshots/discover-web.png)
99

1010
## Required Fields
1111

docs/guide/servers.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can also browse the registry inside the McpMux desktop app under **Discover
2222

2323
For servers not in the registry, you can add them manually in McpMux by providing the server definition JSON directly.
2424

25-
![My Servers page — installed servers with connection status, auth type, and transport badges](/screenshots/servers.png)
25+
![My Servers page — installed servers with connection status, auth type, and transport badges](https://mcpmux.com/screenshots/servers.png)
2626

2727
## Transport Types
2828

@@ -98,7 +98,7 @@ Each installed server has an **enabled/disabled** toggle:
9898

9999
Disabling a server immediately disconnects it and removes its tools from connected clients.
100100

101-
![Expanded server view showing available tools and prompts for each connected server](/screenshots/server-expanded.png)
101+
![Expanded server view showing available tools and prompts for each connected server](https://mcpmux.com/screenshots/server-expanded.png)
102102

103103
## Connection Status
104104

docs/guide/spaces.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Without Spaces, all your MCP credentials and server configurations live in a sin
1616

1717
Spaces solve this by providing **complete isolation** between environments.
1818

19-
![Workspaces page showing My Space (active), Open Source, Personal, and Work spaces](/screenshots/spaces.png)
19+
![Workspaces page showing My Space (active), Open Source, Personal, and Work spaces](https://mcpmux.com/screenshots/spaces.png)
2020

2121
## How Spaces Work
2222

@@ -37,7 +37,7 @@ Only one Space can be **active** at a time. The active Space determines:
3737

3838
Switching the active Space immediately changes what servers and tools are available — no restart required.
3939

40-
![Space switcher dropdown in the sidebar for quick context switching](/screenshots/space-switcher.png)
40+
![Space switcher dropdown in the sidebar for quick context switching](https://mcpmux.com/screenshots/space-switcher.png)
4141

4242
### Default-Enabled Servers
4343

0 commit comments

Comments
 (0)