Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,35 @@ producer step; the final stats response is 60 B.

## Installation

Requires Python 3.11+ and [uv](https://docs.astral.sh/uv/).
Requires Python 3.11+.

**Try it without installing** (needs [uv](https://docs.astral.sh/uv/)):

```bash
uvx toolpipe serve
```

**Install as a tool:**

```bash
pipx install toolpipe # isolated CLI: `toolpipe serve`
# or
uv tool install toolpipe # uv equivalent
```

**Install into a project:**

```bash
pip install toolpipe
# or
uv add toolpipe
```

**From source** (development):

```bash
git clone https://github.com/kunalkaul/toolpipe
cd toolpipe
uv sync
uv run toolpipe --help
```
Expand Down Expand Up @@ -110,19 +136,22 @@ GITHUB_TOKEN = "${GITHUB_TOKEN}"

### MCP client config (generic Claude/Cursor/Codex style)

Plug-and-play entry — no config file:
Plug-and-play entry — no config file, no local checkout:

```json
{
"mcpServers": {
"toolpipe": {
"command": "toolpipe",
"args": ["serve"]
"command": "uvx",
"args": ["toolpipe", "serve"]
}
}
}
```

If `uvx` cold-start latency matters, `pipx install toolpipe` (or
`uv tool install toolpipe`) and use `"command": "toolpipe"` instead.

Pinned-config entry:

```json
Expand Down
Loading