Skip to content

Commit f620622

Browse files
committed
docs: update
1 parent 9786b88 commit f620622

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Agent Chat CLI
22

3-
This is a less feature-rich Python version of [agent-chat-cli](https://github.com/damassi/agent-chat-cli), which uses the [claude-agent-sdk](https://github.com/anthropics/claude-agent-sdk-python) under the hood. Terminal UI is built on top of the very impressive [Textual](https://textual.textualize.io/).
3+
This is the Python version of [agent-chat-cli](https://github.com/damassi/agent-chat-cli), which uses the [claude-agent-sdk](https://github.com/anthropics/claude-agent-sdk-python) under the hood. Terminal UI is built on top of the very impressive [Textual](https://textual.textualize.io/).
44

55
https://github.com/user-attachments/assets/66a1d462-e51a-419f-80f3-fa69ee60db9c
66

77
## Why?
88

9-
This tool is for those who want slightly more control over their MCP servers via configurable system prompts, and a minimal terminal-based MCP form factor for interaction. Many more things are possible thanks to the Claude Agent SDK, but the main purpose, at least for me, is a simple, humble and performant MCP interface to whatever tools I typically use day-to-day.
9+
This tool is for those who want slightly more behavioral control over their MCP servers via configurable system prompts, and a minimal terminal-based MCP form factor for interaction.
1010

11-
> Note: The Python version is visually sturdier than the Node.js version. No more crazy terminal flashing like in Claude Code!
11+
Many different things are possible here thanks to the underlying Claude Agent SDK -- think of this as a light-weight `claude-code` -- but the main purpose, at least for me, is a simple and performant MCP interface to whatever tools I typically use day-to-day, something that lives outside of an editor or `claude` itself.
12+
13+
> **Note**: The Python/Textual version is visually sturdier than the Node.js/React Ink version. No more crazy Node.js terminal jank in long-running sessions!
1214
1315
## Setup
1416

@@ -30,18 +32,20 @@ make start
3032
make dev
3133
```
3234

33-
Additional MCP servers are configured in `agent-chat-cli.config.yaml` and prompts added within the `prompts` folder. By default, MCP servers are loaded dynamically via inference; set `mcp_server_inference: false` to load all servers at startup.
35+
Additional MCP servers are configured in `agent-chat-cli.config.yaml` and prompts added within the `prompts` folder.
36+
37+
Optionally, MCP servers can be lazy-loaded via chat inference, which is useful if you have many MCP servers or MCP servers with many tools; set `mcp_server_inference: true` to enable it.
3438

3539
## Development
3640

3741
- Install pre-commit hooks via [pre-commit](https://pre-commit.com/)
3842
- `uv run pre-commit install`
39-
- Typechecking is via [MyPy](https://github.com/python/mypy):
43+
- Type-checking is via [MyPy](https://github.com/python/mypy):
4044
- `uv run mypy src`
4145
- Linting and formatting is via [Ruff](https://docs.astral.sh/ruff/)
4246
- `uv run ruff check src`
4347

44-
Textual has an integrated logging console which one can boot separately from the app to receive logs.
48+
Textual has an integrated logging console that one can boot separately from the app to receive logs.
4549

4650
In one terminal pane boot the console:
4751

0 commit comments

Comments
 (0)