Skip to content

Commit 90b994b

Browse files
committed
Install from PyPI: uv tool install, uvx in the MCP client configs
1 parent 0c39ca5 commit 90b994b

2 files changed

Lines changed: 27 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ It is for technical people who want to run it themselves, **for noncommercial us
1616
[![MCP Badge](https://lobehub.com/badge/mcp/cotletdev-substack-api-mcp-server)](https://lobehub.com/mcp/cotletdev-substack-api-mcp-server)
1717

1818
```bash
19-
git clone https://github.com/cotletdev/substack-api-mcp-server.git && cd substack-api-mcp-server
20-
python3 -m venv .venv && . .venv/bin/activate && pip install -e .
19+
uv tool install substack-api-mcp # or: pip install substack-api-mcp
2120
substack-mcp connect # reads your Substack session from Chrome
2221
substack-mcp call list_posts
23-
claude mcp add substack -- "$PWD/.venv/bin/substack-mcp" mcp
22+
claude mcp add substack -- uvx --from substack-api-mcp substack-mcp mcp
2423
```
2524

2625
## Contents
@@ -63,6 +62,17 @@ Substack's session cookie (`substack.sid`) lasts about three months. When Substa
6362

6463
## Install
6564

65+
From [PyPI](https://pypi.org/project/substack-api-mcp/):
66+
67+
```bash
68+
uv tool install substack-api-mcp # or: pipx install substack-api-mcp, or: pip install substack-api-mcp
69+
substack-mcp --version
70+
```
71+
72+
MCP clients can also run it with no install: `uvx --from substack-api-mcp substack-mcp mcp`.
73+
74+
From source:
75+
6676
```bash
6777
git clone https://github.com/cotletdev/substack-api-mcp-server.git
6878
cd substack-api-mcp-server
@@ -76,7 +86,7 @@ With [uv](https://docs.astral.sh/uv/): `uv venv && uv pip install -e .`, then `u
7686

7787
Setting it up with an AI agent (Claude Code, Codex, Cursor)? Open it in this folder and ask it to set up the repo: [`AGENTS.md`](AGENTS.md) tells it every step, and it asks you only for the steps in Chrome.
7888

79-
To update: `git pull && pip install -e .`. We copy every change of the hosted Substack tools into this repo.
89+
To update: `uv tool upgrade substack-api-mcp` (or `pip install -U substack-api-mcp`), from source `git pull && pip install -e .`. We copy every change of the hosted Substack tools into this repo.
8090

8191
## Connect your Chrome
8292

@@ -143,9 +153,9 @@ The MCP server lists every tool with its input schema, a description written for
143153
### Claude Code
144154

145155
```bash
146-
claude mcp add substack -- /path/to/substack-api-mcp-server/.venv/bin/substack-mcp mcp
156+
claude mcp add substack -- uvx --from substack-api-mcp substack-mcp mcp
147157
# read only:
148-
claude mcp add substack -- /path/to/substack-api-mcp-server/.venv/bin/substack-mcp mcp --read-only
158+
claude mcp add substack -- uvx --from substack-api-mcp substack-mcp mcp --read-only
149159
```
150160

151161
### Claude Desktop
@@ -156,8 +166,8 @@ claude mcp add substack -- /path/to/substack-api-mcp-server/.venv/bin/substack-m
156166
{
157167
"mcpServers": {
158168
"substack": {
159-
"command": "/path/to/substack-api-mcp-server/.venv/bin/substack-mcp",
160-
"args": ["mcp"]
169+
"command": "uvx",
170+
"args": ["--from", "substack-api-mcp", "substack-mcp", "mcp"]
161171
}
162172
}
163173
}
@@ -173,8 +183,8 @@ claude mcp add substack -- /path/to/substack-api-mcp-server/.venv/bin/substack-m
173183

174184
```toml
175185
[mcp_servers.substack]
176-
command = "/path/to/substack-api-mcp-server/.venv/bin/substack-mcp"
177-
args = ["mcp"]
186+
command = "uvx"
187+
args = ["--from", "substack-api-mcp", "substack-mcp", "mcp"]
178188
```
179189

180190
### Over HTTP

‎mcp.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
{
22
"mcpServers": {
33
"substack": {
4-
"command": "/path/to/substack-api-mcp-server/.venv/bin/substack-mcp",
5-
"args": ["mcp"]
4+
"command": "uvx",
5+
"args": [
6+
"--from",
7+
"substack-api-mcp",
8+
"substack-mcp",
9+
"mcp"
10+
]
611
}
712
}
813
}

0 commit comments

Comments
 (0)