Skip to main content

iterm2-py-mcp-server

MCP server for iTerm2 on macOS, written in pure Python. Lets Claude (Desktop, primarily) read what's on your terminal screens and scrollback, search inside long log dumps, and — optionally, behind a feature flag — drive iTerm2 sessions by sending text or control keys.

Status: v0.1.0, stages 0–4 complete; 8 readonly tools always available, 4 write tools behind ITERM_MCP_ALLOW_WRITE=1. See docs/PLAN.md for full status and docs/TOOLS.md for the tool reference.

Why

When you're SSH'd into a remote box and tail something long — logs, a process tree, a journalctl dump — pasting it into Claude is tedious and lossy. This MCP server gives Claude a direct, read-only window into the terminal you're already looking at, so you can just ask questions about it.

Quick start

# Install from source into the current Python environment
pip install -e .

# Or run without installing (once published)
uvx iterm2-py-mcp

Then add to your ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "iterm2": {
      "command": "iterm2-py-mcp"
    }
  }
}

Full setup walk-through (enabling the iTerm2 Python API, granting access, verifying with iterm_status) lives in docs/INSTALL.md.

Documentation

Doc What's in it
docs/README.md Documentation index
docs/PLAN.md Roadmap, stages, what's done / TODO
docs/INSTALL.md Install, build, configure Claude Desktop
docs/ARCHITECTURE.md How it's wired internally
docs/TOOLS.md Reference for every MCP tool
docs/TROUBLESHOOTING.md Common errors and fixes
docs/IDEAS.md Backlog of possible future features

License

GNU Lesser General Public License v3.0 (LGPLv3).

Metadata

Release files for iterm2-py-mcp 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iterm2-py-mcp 0.1.0
File Size Uploaded
iterm2_py_mcp-0.1.0.tar.gz 29.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for iterm2-py-mcp 0.1.0
File Interpreter ABI Platform
iterm2_py_mcp-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 52.9 kB

Release files / iterm2_py_mcp-0.1.0.tar.gz

Download URL iterm2_py_mcp-0.1.0.tar.gz
Size 29.1 kB
Tags Source
SHA-256 checksum
How to use checksums
a0398a83086d14b3876438f974fd0c627575f39f159eb76138c277f546b79182
BLAKE2b-256 checksum
How to use checksums
6b6e8a182bb298815597b419d6a4d8cb70a5432f1cf1b4c8a56af046bc39e704
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 27, 2026.

Transparency log

Release files / iterm2_py_mcp-0.1.0-py3-none-any.whl

Download URL iterm2_py_mcp-0.1.0-py3-none-any.whl
Size 23.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c7b16d99037c82b402f3869ef91457e0b922c077eb8b5f29fe8bce5b6a514a51
BLAKE2b-256 checksum
How to use checksums
a1057c473b29becf8477d9a90a110a96a9e0e5e73d7152ec6e2f59e625e108a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 27, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page