Skip to content

Commit e2265f3

Browse files
committed
docs: Add compatibility matrix
why: When something breaks after an upgrade, this is the first page users check. Saves real support time. what: - Create docs/reference/compatibility.md - Document Python, tmux, dependency, MCP client, and OS compatibility - Include transport type for each client
1 parent e2ce690 commit e2265f3

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

docs/reference/compatibility.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
(compatibility)=
2+
3+
# Compatibility
4+
5+
## Python versions
6+
7+
| Python | Status |
8+
|--------|--------|
9+
| 3.10 | Supported |
10+
| 3.11 | Supported |
11+
| 3.12 | Supported |
12+
| 3.13 | Supported |
13+
| 3.14 | Supported |
14+
| PyPy | Supported |
15+
16+
## tmux versions
17+
18+
| tmux | Status |
19+
|------|--------|
20+
| >= 3.2a | Supported |
21+
| < 3.2a | Not supported (libtmux requirement) |
22+
23+
## Dependencies
24+
25+
| Package | Required version |
26+
|---------|-----------------|
27+
| [libtmux](https://libtmux.git-pull.com/) | >= 0.55.0, < 1.0 |
28+
| [FastMCP](https://github.com/jlowin/fastmcp) | >= 3.1.0, < 4.0.0 |
29+
30+
## MCP clients
31+
32+
| Client | Tested | Transport |
33+
|--------|--------|-----------|
34+
| Claude Code | Yes | stdio |
35+
| Claude Desktop | Yes | stdio |
36+
| Codex CLI | Yes | stdio |
37+
| Gemini CLI | Yes | stdio |
38+
| Cursor | Yes | stdio |
39+
| MCP Inspector | Yes | stdio |
40+
41+
## OS support
42+
43+
| Platform | Status |
44+
|----------|--------|
45+
| Linux | Supported |
46+
| macOS | Supported |
47+
| WSL2 | Supported |
48+
| Windows (native) | Not supported (tmux requires Unix) |

0 commit comments

Comments
 (0)