Skip to content

Commit f5e6fb5

Browse files
committed
🤖 docs: add MCP servers documentation
1 parent 0908154 commit f5e6fb5

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
},
5555
"context-management",
5656
"instruction-files",
57+
"mcp-servers",
5758
{
5859
"group": "Project Secrets",
5960
"pages": ["project-secrets", "agentic-git-identity"]

docs/mcp-servers.mdx

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: MCP Servers
3+
description: Extend agent capabilities with Model Context Protocol servers
4+
---
5+
6+
MCP (Model Context Protocol) servers provide additional tools to agents. Configure them per-project in `.mux/mcp.jsonc`.
7+
8+
## Configuration
9+
10+
Create `.mux/mcp.jsonc` in your project root:
11+
12+
```jsonc
13+
{
14+
"servers": {
15+
// Knowledge graph for persistent memory
16+
"memory": "npx -y @anthropic-ai/mcp-server-memory",
17+
// Access external APIs
18+
"github": "npx -y @modelcontextprotocol/server-github",
19+
},
20+
}
21+
```
22+
23+
Each entry maps a server name to its shell command. The command must start a process that speaks MCP over stdio (NDJSON format).
24+
25+
## Settings UI
26+
27+
Configure servers in **Settings → Projects**:
28+
29+
1. Select a project from the dropdown
30+
2. Add servers with name and command
31+
3. Use **Test** to verify before adding
32+
4. View available tools after successful test
33+
34+
## Behavior
35+
36+
- **Hot reload** — Config changes apply on your next message (no restart needed)
37+
- **Per-workspace** — Each workspace maintains its own server instances
38+
- **Isolated** — Server processes run in the workspace directory with its environment
39+
40+
## Finding MCP Servers
41+
42+
Browse available servers at [mcp.so](https://mcp.so/) or the [MCP servers repository](https://github.com/modelcontextprotocol/servers).
43+
44+
## Troubleshooting
45+
46+
If a server fails to start:
47+
48+
1. **Test the command manually** — Run the command in your terminal to verify it works
49+
2. **Check dependencies** — Ensure required packages are installed (`npx -y` downloads on first run)
50+
3. **Review logs** — Server errors appear in mux logs (`~/.mux/logs/`)

0 commit comments

Comments
 (0)