iterm-mcp

Name: iterm-mcp
Author: ferrislucas

byferrislucas· 1 MCP server

Installs

550

Stars

566

Forks

How to install iterm-mcp?

ferrislucas/iterm-mcp

$git clone https://github.com/ferrislucas/iterm-mcp

Installs into the current project.

›Prefer a prompt? Paste this to your agent

Install & use

Install iterm-mcp by running `git clone https://github.com/ferrislucas/iterm-mcp`, then use it for the current task and follow its documentation at https://github.com/ferrislucas/iterm-mcp.

Files · 1

View on GitHub

README.md

1	# iterm-mcp
2	A Model Context Protocol server that provides access to your iTerm session.
3
4	![Main Image](.github/images/demo.gif)
5
6	### Features
7
8	Efficient Token Use: iterm-mcp gives the model the ability to inspect only the output that the model is interested in. The model typically only wants to see the last few lines of output even for long running commands.
9
10	Natural Integration: You share iTerm with the model. You can ask questions about what's on the screen, or delegate a task to the model and watch as it performs each step.
11
12	Full Terminal Control and REPL support: The model can start and interact with REPL's as well as send control characters like ctrl-c, ctrl-z, etc.
13
14	Easy on the Dependencies: iterm-mcp is built with minimal dependencies and is runnable via npx. It's designed to be easy to add to Claude Desktop and other MCP clients. It should just work.
15
16
17	## Safety Considerations
18
19	* The user is responsible for using the tool safely.
20	* No built-in restrictions: iterm-mcp makes no attempt to evaluate the safety of commands that are executed.
21	* Models can behave in unexpected ways. The user is expected to monitor activity and abort when appropriate.
22	* For multi-step tasks, you may need to interrupt the model if it goes off track. Start with smaller, focused tasks until you're familiar with how the model behaves.
23
24	### Tools
25	- `write_to_terminal` - Writes to the active iTerm terminal, often used to run a command. Returns the number of lines of output produced by the command.
26	- `read_terminal_output` - Reads the requested number of lines from the active iTerm terminal.
27	- `send_control_character` - Sends a control character to the active iTerm terminal.
28
29	### Requirements
30
31	* iTerm2 must be running
32	* Node version 18 or greater
33
34
35	## Installation
36
37	To use with Claude Desktop, add the server config:
38
39	On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
40	On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
41
42	```json
43	{
44	"mcpServers": {
45	"iterm-mcp": {
46	"command": "npx",
47	"args": [
48	"-y",
49	"iterm-mcp"
50	]
51	}
52	}
53	}
54	```
55
56	### Installing via Smithery
57
58	To install iTerm for Claude Desktop automatically via [Smithery](https://smithery.ai/server/iterm-mcp):
59
60	```bash
61	npx -y @smithery/cli install iterm-mcp --client claude
62	```
63	[![smithery badge](https://smithery.ai/badge/iterm-mcp)](https://smithery.ai/server/iterm-mcp)
64
65	## Development
66
67	Install dependencies:
68	```bash
69	yarn install
70	```
71
72	Build the server:
73	```bash
74	yarn run build
75	```
76
77	For development with auto-rebuild:
78	```bash
79	yarn run watch
80	```
81
82	### Debugging
83
84	Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
85
86	```bash
87	yarn run inspector
88	yarn debug <command>
89	```
90
91	The Inspector will provide a URL to access debugging tools in your browser.

6 picks

Type

iterm-mcp

byferrislucas· 1 MCP server

Installs

550

Stars

566

Forks

How to install iterm-mcp?

ferrislucas/iterm-mcp

$git clone https://github.com/ferrislucas/iterm-mcp

Installs into the current project.

›Prefer a prompt? Paste this to your agent

Install & use

Install iterm-mcp by running `git clone https://github.com/ferrislucas/iterm-mcp`, then use it for the current task and follow its documentation at https://github.com/ferrislucas/iterm-mcp.

Files · 1

View on GitHub

README.md

1	# iterm-mcp
2	A Model Context Protocol server that provides access to your iTerm session.
3
4	![Main Image](.github/images/demo.gif)
5
6	### Features
7
8	Efficient Token Use: iterm-mcp gives the model the ability to inspect only the output that the model is interested in. The model typically only wants to see the last few lines of output even for long running commands.
9
10	Natural Integration: You share iTerm with the model. You can ask questions about what's on the screen, or delegate a task to the model and watch as it performs each step.
11
12	Full Terminal Control and REPL support: The model can start and interact with REPL's as well as send control characters like ctrl-c, ctrl-z, etc.
13
14	Easy on the Dependencies: iterm-mcp is built with minimal dependencies and is runnable via npx. It's designed to be easy to add to Claude Desktop and other MCP clients. It should just work.
15
16
17	## Safety Considerations
18
19	* The user is responsible for using the tool safely.
20	* No built-in restrictions: iterm-mcp makes no attempt to evaluate the safety of commands that are executed.
21	* Models can behave in unexpected ways. The user is expected to monitor activity and abort when appropriate.
22	* For multi-step tasks, you may need to interrupt the model if it goes off track. Start with smaller, focused tasks until you're familiar with how the model behaves.
23
24	### Tools
25	- `write_to_terminal` - Writes to the active iTerm terminal, often used to run a command. Returns the number of lines of output produced by the command.
26	- `read_terminal_output` - Reads the requested number of lines from the active iTerm terminal.
27	- `send_control_character` - Sends a control character to the active iTerm terminal.
28
29	### Requirements
30
31	* iTerm2 must be running
32	* Node version 18 or greater
33
34
35	## Installation
36
37	To use with Claude Desktop, add the server config:
38
39	On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
40	On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
41
42	```json
43	{
44	"mcpServers": {
45	"iterm-mcp": {
46	"command": "npx",
47	"args": [
48	"-y",
49	"iterm-mcp"
50	]
51	}
52	}
53	}
54	```
55
56	### Installing via Smithery
57
58	To install iTerm for Claude Desktop automatically via [Smithery](https://smithery.ai/server/iterm-mcp):
59
60	```bash
61	npx -y @smithery/cli install iterm-mcp --client claude
62	```
63	[![smithery badge](https://smithery.ai/badge/iterm-mcp)](https://smithery.ai/server/iterm-mcp)
64
65	## Development
66
67	Install dependencies:
68	```bash
69	yarn install
70	```
71
72	Build the server:
73	```bash
74	yarn run build
75	```
76
77	For development with auto-rebuild:
78	```bash
79	yarn run watch
80	```
81
82	### Debugging
83
84	Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
85
86	```bash
87	yarn run inspector
88	yarn debug <command>
89	```
90
91	The Inspector will provide a URL to access debugging tools in your browser.

6 picks

Type

iterm-mcp

How to install iterm-mcp?

Related

iterm-mcp

How to install iterm-mcp?

Related