Skip to content

Commit f4b136a

Browse files
committed
refactor(docs): add PyPI install
1 parent be6817a commit f4b136a

3 files changed

Lines changed: 15 additions & 22 deletions

File tree

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ version: 2
88
build:
99
os: ubuntu-24.04
1010
tools:
11-
python: "3.9"
11+
python: "3.10"
1212

1313
python:
1414
install:

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -55,46 +55,40 @@ enabling tools and libraries to communicate successfully with a uniform workflow
5555

5656
## Installation
5757

58-
> [!NOTE]
59-
> MCPStack is the orchestrator — it comes with core utilities and validated tools.
60-
> All validated tools are listed under `mcp_tools` in the `pyproject.toml` and are auto-registered via
61-
> `[project.entry-points."mcpstack.tools"]`.
62-
63-
### Clone the repository
64-
65-
```bash
66-
git clone https://github.com/MCP-Pipeline/MCPStack.git
67-
cd MCPStack
68-
```
69-
7058
### Install dependencies
7159

72-
Using UV (recommended):
60+
Using `UV` _(recommended, [see Astral UV official doc here](https://docs.astral.sh/uv/))_:
7361

7462
```bash
75-
uv sync
63+
uv add mcpstack
7664
```
7765

78-
Using pip:
66+
Using `pip`:
7967

8068
```bash
81-
pip install -e .[dev]
69+
pip install mcpstack
8270
```
8371

8472
### Install pre-commit hooks
8573

86-
Via UV:
74+
Via `UV`:
8775

8876
```bash
8977
uv run pre-commit install
9078
```
9179

92-
Via pip:
80+
Via `pip`:
9381

9482
```bash
9583
pre-commit install
9684
```
9785

86+
> [!NOTE]
87+
> MCPStack is the orchestrator — it comes with core utilities and validated tools.
88+
> All MCPStack MCP tools are auto-registered via their `[project.entry-points."mcpstack.tools"]`.
89+
> As such, simply add the tool(s) of interest via `UV` or `pip`, and it/they will be auto-registered.
90+
91+
9892
## 🖥️ CLI Workflow
9993

10094
You can manage and run your MCP pipelines directly from the CLI with the `mcpstack` command.

requirements-dev.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ idna==3.10
5757
iniconfig==2.1.0
5858
ipykernel==6.30.1
5959
ipython==8.37.0
60-
ipython==9.4.0
6160
ipython-pygments-lexers==1.1.1
6261
isodate==0.7.2
6362
jedi==0.19.2
@@ -147,7 +146,7 @@ pyyaml-env-tag==1.1
147146
pyzmq==27.0.1
148147
rapidfuzz==3.13.0
149148
referencing==0.36.2
150-
requests==2.32.4
149+
requests==2.32.5
151150
rfc3339-validator==0.1.4
152151
rich==14.1.0
153152
rich-pyfiglet==1.0.0
@@ -167,7 +166,7 @@ tinycss2==1.4.0
167166
tomli==2.2.1
168167
tornado==6.5.2
169168
traitlets==5.14.3
170-
typer==0.16.0
169+
typer==0.16.1
171170
typing-extensions==4.14.1
172171
typing-inspection==0.4.1
173172
urllib3==2.5.0

0 commit comments

Comments
 (0)