✨ Winx - MCP Server for Shell & Coding Agents ✨
<p align="center"> <strong>🦀 Native Rust implementation inspired by WCGW, built for local code-agent workflows</strong> </p> <p align="center"> <img src="https://img.shields.io/badge/language-Rust-orange?style=flat&logo=rust" alt="Language" /> <img src="https://img.shields.io/badge/license-MIT-blue?style=flat" alt="License" /> <img src="https://img.shields.io/badge/MCP-compatible-purple?style=flat" alt="MCP" /> <img src="https://img.shields.io/badge/transport-stdio-2f855a?style=flat" alt="stdio transport" /> </p> <p align="center"> <em>A local MCP server you can hand to a coding agent and stop worrying about the shell.</em> </p>Winx is the MCP server I wanted while running Claude, Codex, and friends against real repos: one process that handles the shell, file IO, and PTY-backed interactive sessions, written in Rust so it doesn't fight you on stdio.
It started as a Rust port of WCGW but isn't a Python wrapper. Everything runs on a
real PTY (via portable-pty), cd actually sticks, Ctrl+C actually interrupts, and background shells survive
long-running TUIs without leaking output buffers into your token budget.
What you get
- A stateful bash session per thread with proper PTY semantics - foreground, background, status checks, text input,
Enter/Ctrl-C/Ctrl-D, raw ASCII. Multiline scripts and top-level
commandshorthand both work; NUL bytes are rejected before they reach the shell. - Workspaces with three modes:
wcgw(full access),architect(read-only),code_writer(allowlist of commands and write globs). The command allowlist is parsed with tree-sitter, so it checks every command on the line - pipelines,&&/||/;, command substitution, subshells - not just the first word, and can't be bypassed withls && curl … | shorls $(rm …). - A resilient PTY: a shell that won't return to a prompt (even after Ctrl-C) is auto-reset at the same cwd/mode, child
processes are reaped on drop, and prompt detection is robust to a custom
PS1. Opt intozshwithWINX_SHELL=zsh. - File reads with WCGW-style line ranges (
file.rs:10-40,file.rs:10-,file.rs:-40). Active files are tracked and prioritized in the repository context across calls. - File writes and SEARCH/REPLACE edits that survive ambiguous matches, indentation drift, and the usual unicode
quote-mismatches from LLMs. Writes are blocked when the file hasn't been read or the cached content is stale, the
success message shows a compact diff of what changed, and recent edits are reversible with
UndoEdit.MultiFileEditapplies a change across several files all-or-nothing (validated in memory first, so a failure on the last file leaves the earlier ones untouched). - Tree-sitter code navigation via
CodeMap: a token-budgeted symbol map of a file or the whole repo, or a definition/reference lookup for a symbol name - the semantic view that plaingrepcan't give you, across 11 languages. ContextSavefor handing a task summary plus its files to the next session - including workspace context, active files, git status/diff, and terminal sharing for proper resumption. Resuming reopens the saved project root and token-caps the restored memory so it never overflows the context window.ReadImageso multimodal clients can pull screenshots, mockups, error PNGs, etc.- Clean, token-aware shell output: cursor/ANSI noise from interactive programs (REPLs, progress
bars) is rendered away through a terminal emulator, and mechanical repetition is collapsed
losslessly (
line [winx: ×N]) so build/install logs don't blow your context budget. Toggle the collapsing withWINX_NO_COMPRESS. When output still overflows the cap, the dropped head is streamed to a scratch file under.winx/scratch/the agent can re-read, instead of being lost. - Secret redaction on by default: provider API keys, JWTs, PEM private-key blocks and
user:pass@URLs are scrubbed from all tool output and saved memory before they reach the model (disable withWINX_NO_REDACT=1). An opt-in Landlock sandbox (WINX_SANDBOX=1, Linux) adds a kernel-enforced second layer that confines writes to the workspace and hides the home directory. - Two transports: stdio for local clients, plus an optional token-gated Streamable HTTP server
(
winx serve --http) for remote MCP clients like ChatGPT - see Remote access.
MCP Tools
| Tool | What it does |
|---|---|
Initialize | Boots the workspace, picks the mode, hands you a thread_id. Call this first or everything else errors out. With no workspace path it spins up a scratch playground; resuming a task (task_id_to_resume) reopens its saved project root. |
BashCommand | Runs commands, polls long-running ones, sends Enter/Ctrl-C, drives TUIs. Supports is_background, status_check, send_text, send_specials, send_ascii, allow_multi, plus screen (a stable point-in-time frame of an interactive TUI with the cursor position; pass diff:true for only the lines that changed since your last look) and wait_for_turn (block until the TUI is ready for input, via per-app or configurable recognizers). When a foreground command finishes, the status line reports its real exit code (parsed from the prompt marker), so failures surface without grepping stderr. |
ReadFiles | One or many files, with line numbers. Append :10-40 to a path for a range. When the token budget is hit it tells you the exact line + file:N-M syntax to resume from instead of silently dropping the tail. |
FileWriteOrEdit | Full overwrites or SEARCH/REPLACE blocks (with optional @start-end line anchors to pin a repeated block). Validates file read coverage and freshness before writing, reports any fuzzy tolerances it had to apply, then runs a tree-sitter syntax check (18+ languages) and points at the offending line with a snippet. The success message includes a compact diff of what changed. |
MultiFileEdit | Edits several files all-or-nothing: every file's edit is validated and computed in memory first, and only if all succeed is anything written - so a SEARCH that fails to match in the last file leaves the earlier ones untouched. For a single file use FileWriteOrEdit. |
UndoEdit | Reverts a file to its content before the last FileWriteOrEdit/MultiFileEdit this session (per-file, last ~10 edits kept in memory). Refused if the file changed on disk since your edit; a brand-new file's creation isn't undoable. |
ContextSave | Dumps task description + file globs into a single text file with workspace context, active files, and git status/diff for clean handoff and task resumption. |
ReadImage | Returns a native MCP image content block (not base64 as text), so multimodal models actually see the image. Confined to the workspace (like ReadFiles) and size-capped. |
CodeMap | Tree-sitter code navigation, in one tool with two operations. outline: a symbol map (functions, types, methods, ...) - a file returns its definitions, a directory (or empty) a relevance-ranked, token-budgeted repo symbol map, in 11 languages. references: where a name is defined and used (called) across the repo, counting only real identifier occurrences (never inside strings/comments, unlike grep), definitions first. For plain-text/regex search and file discovery, just use rg/fd/grep via BashCommand. |
Search/Replace editing
Standard block syntax:
<<<<<<< SEARCH
old content
=======
new content
>>>>>>> REPLACEThings the matcher forgives so you don't have to babysit the model:
- atomic: ambiguous or missing matches abort without touching the file
- adjusts replacement indentation when the LLM gets the leading whitespace wrong
- strips
ReadFilesline numbers if they leak into a SEARCH block - normalizes the usual "smart quote" / em-dash / ellipsis substitutions
- uses neighboring blocks to disambiguate when the same snippet appears twice
- single-line substring edits work - you don't need the whole line in SEARCH
- retries once with
\"unescaped when the model over-escapes quotes in SEARCH - refuses edits that only matched after too much fuzzy fixup, and rejects blocks that match in too many places - so you re-read instead of corrupting the file
- anchor a block to a line number to pin one of several identical snippets -
<<<<<<< SEARCH @42(or a range@42-50); a stale anchor falls back to the normal search, so it never fails an otherwise-valid edit - tells you on success which tolerances it had to apply (so you learn your
SEARCH drifted), and on a miss how close the nearest match was, with
~marking the lines that diverged
Install
cargo install winx-code-agentBinary lands in ~/.cargo/bin - every config snippet below assumes that's on $PATH. If your MCP client launches with
a sterile env, swap winx-code-agent for the absolute path (which winx-code-agent).
Needs Rust 1.75+, Linux/macOS/WSL2, and a real terminal (any modern one - Winx spawns its own PTY).
<details> <summary><b>Claude Code (CLI)</b></summary>One-liner via the CLI (stdio is the default transport):
claude mcp add winx -- winx-code-agentOr drop a .mcp.json in your project root:
{
"mcpServers": {
"winx": {
"command": "winx-code-agent",
"env": { "RUST_LOG": "winx_code_agent=info" }
}
}
}Add to your config file (~/Library/Application Support/Claude/claude_desktop_config.json on macOS, %APPDATA%\Claude\claude_desktop_config.json on Windows):
{
"mcpServers": {
"winx": {
"command": "winx-code-agent",
"env": { "RUST_LOG": "winx_code_agent=info" }
}
}
}Restart Claude Desktop after saving.
</details> <details> <summary><b>Codex (OpenAI CLI)</b></summary>One-liner:
codex mcp add winx -- winx-code-agentOr edit ~/.codex/config.toml:
[mcp_servers.winx]
command = "winx-code-agent"
env = { RUST_LOG = "winx_code_agent=info" }Add to ~/.cursor/mcp.json (or .cursor/mcp.json for project-local):
{
"mcpServers": {
"winx": {
"command": "winx-code-agent",
"env": { "RUST_LOG": "winx_code_agent=info" }
}
}
}Add to .vscode/mcp.json:
{
"servers": {
"winx": {
"type": "stdio",
"command": "winx-code-agent"
}
}
}Add to your Zed settings (~/.config/zed/settings.json):
{
"context_servers": {
"winx": {
"source": "custom",
"command": "winx-code-agent",
"args": [],
"env": { "RUST_LOG": "winx_code_agent=info" }
}
}
}Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"winx": {
"command": "winx-code-agent",
"env": { "RUST_LOG": "winx_code_agent=info" }
}
}
}Add to opencode.json:
{
"m
…