Sublime Text MCP
MCP server for Sublime Text 4. Lets AI coding agents read and control a running ST instance.
Open source Open in the app JSON README (API)
About
MCP server for Sublime Text 4. Lets AI coding agents read and control a running ST instance.
Details
- Kind
- MCP servers
- Topic
- No topic detected
- Publisher
- dpc00
- Origin
- official
- Category
- ferramentas
- Transport
- local
- Version
- 1.0.0
- Stars
- 1
- Last push
- 2026-09-07T07:11:02Z
- Repository state
- ativo
- Language
- Python
- License
- MIT
- Added
- 2026-08-29 03:02:43
- Updated
- 2026-09-09 21:03:12
- Origin id
io.github.dpc00/sublime-mcp
README
# Sublime-MCP: Universal AI Agent Connector for Sublime Text
Gives any MCP-speaking AI agent real control over a running Sublime Text 4
instance: run registered ST commands, read/write views and selections, inspect
tabs and project state, and `eval_python` in Sublime's plugin host for anything
the typed tools don't cover.
Two optional companion plugins extend this:
- **debugger-mcp** — Debugger package DAP tools (breakpoints, stepping,
variables, call stacks) over MCP
- **lsp-mcp** — LSP tools (definition, references, diagnostics, rename, hover)
over MCP
## Toolset
Seven workflow tools are advertised by default. `discover_tools` searches the
complete internal catalog of 222 typed Sublime capabilities, and `batch` invokes
discovered capabilities without flooding the model's initial tool context.
debugger-mcp and lsp-mcp use the same focused pattern: each advertises seven
workflow tools by default, with `debugger_discover_tools` / `lsp_discover_tools`
and prefixed batch tools providing access to the complete catalogs (104 and
125 tools respectively).
Agent how-to: [docs/AGENT_GUIDE.md](docs/AGENT_GUIDE.md) (also served live by
`get_help`). Workflow across all three MCPs: [docs/agents.md](docs/agents.md).
Release history: [CHANGELOG.md](CHANGELOG.md).
## Ports
Each plugin serves **MCP streamable HTTP** at `/mcp`, legacy **MCP SSE** at
`/sse`, and a **plain HTTP bridge**.
The bundled Node/Python proxies use sublime-mcp's HTTP bridge only. Defaults:
| Plugin | MCP SSE | HTTP bridge | Settings file |
| ------------- | ------------------------------- | ------------------------------- | ------------------------------------- |
| sublime-mcp | 9502 (Win) / 9503 (macOS/Linux) | 9500 (Win) / 9501 (macOS/Linux) | `sublime-mcp.sublime-settings` |
| debugger-mcp | 9505 | 9515 | `debugger-mcp.sublime-settings` |
| lsp-mcp | 9506 | 9516 | `lsp-mcp.sublime-settings` |
Each settings file takes `"mcp_port"` and `"http_port"` keys; edit your copy
under `Packages/User/` (Preferences > Package Settings) to override the
defaults above — no env vars needed.
SSE URL form: `http://127.0.0.1:<sse-port>/sse`. The bundled Node/Python
proxies talk to sublime-mcp's **HTTP bridge**, not SSE; override with
`SUBLIME_MCP_BASE` (e.g. `http://127.0.0.1:9500`).
## Installation
### 1. Clone
```bash
git clone https://github.com/dpc00/sublime-mcp.git
cd sublime-mcp
```
### 2. Install the Sublime Text plugin
Symlink `packages/st-plugin` into ST's `Packages/` directory as `sublime-mcp`.
**Windows (Command Prompt):**
```cmd
mklink /J "%APPDATA%\Sublime Text\Packages\sublime-mcp" "C:\path\to\sublime-mcp\packages\st-plugin"
```
**macOS:**
```bash
ln -s "$(pwd)/packages/st-plugin" "$HOME/Library/Application Support/Sublime Text/Packages/sublime-mcp"
```
**Linux:**
```bash
ln -s "$(pwd)/packages/st-plugin" "$HOME/.config/sublime-text/Packages/sublime-mcp"
```
### 3. Optional companion plugins
Same pattern: symlink `packages/debugger-mcp` and/or `packages/lsp-mcp` into
`Packages/` under those names.
**Windows:**
```cmd
mklink /J "%APPDATA%\Sublime Text\Packages\debugger-mcp" "C:\path\to\sublime-mcp\packages\debugger-mcp"
mklink /J "%APPDATA%\Sublime Text\Packages\lsp-mcp" "C:\path\to\sublime-mcp\packages\lsp-mcp"
```
**macOS:**
```bash
ln -s "$(pwd)/packages/debugger-mcp" "$HOME/Library/Application Support/Sublime Text/Packages/debugger-mcp"
ln -s "$(pwd)/packages/lsp-mcp" "$HOME/Library/Application Support/Sublime Text/Packages/lsp-mcp"
```
**Linux:**
```bash
ln -s "$(pwd)/packages/debugger-mcp" "$HOME/.config/sublime-text/Packages/debugger-mcp"
ln -s "$(pwd)/packages/lsp-mcp" "$HOME/.config/sublime-text/Packages/lsp-mcp"
```
Restart Sublime Text after linking so the plugins load.
### 4. Configure your agent
**Node:**
```bash
cd packages/node-proxy
npm install .
npx sublime-mcp
```
**Python:**
```bash
cd packages/python-proxy
pip install .
sublime-mcp
```
For Codex, use its native streamable-HTTP configuration; no `mcp-remote`
wrapper is required:
```toml
[mcp_servers.sublime-mcp]
type = "http"
url = "http://127.0.0.1:9502/mcp"
[mcp_servers.debugger-mcp]
type = "http"
url = "http://127.0.0.1:9505/mcp"
[mcp_servers.lsp-mcp]
type = "http"
url = "http://127.0.0.1:9506/mcp"
```
Restart or open a new Codex session after changing MCP configuration. Verify
the entire path before debugging agent behavior:
```bash
npx sublime-mcp doctor
npx sublime-mcp doctor --all
```
The first command checks sublime-mcp. `--all` also checks debugger-mcp and
lsp-mcp. The report separately checks each HTTP bridge, MCP handshake, and
focused tool catalog. From Sublime's Command Palette,
`MCP Commander: Connection Doctor` shows the main server-side state.
Other MCP clients may use the legacy SSE URL (Windows example):
```json
{
"mcpServers": {
"sublime-mcp": { "type": "sse", "url": "http://127.0.0.1:9502/sse" }
}
}
```
Each plugin's MCP server starts automatically when ST loads it. To stop or
restart sublime-mcp's, run "MCP Commander: Server Status" from the Command
Palette. Check View > Show Console for startup confirmation.
## Agent skill
Installable Codex skills are in `skills/sublime-mcp`,
`skills/sublime-debugger`, and `skills/sublime-lsp`. Copy the desired
directories to your Codex skills directory or install them through your normal
skill workflow.