You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update PeasyAI README with prerequisites and installation improvements
Point users to the P installation guide for .NET SDK 8.0, Java, and
the P compiler. Add Quick Start section, troubleshooting table, upgrade
instructions, and reorganize development sections.
Co-authored-by: Cursor <cursoragent@cursor.com>
PeasyAI relies on the P toolchain at runtime to compile and model-check your programs. Make sure the following are installed **before** using PeasyAI:
42
+
43
+
| Dependency | Why it's needed | Install |
44
+
|------------|-----------------|---------|
45
+
|**Python ≥ 3.10**| Runs the PeasyAI MCP server |[python.org/downloads](https://www.python.org/downloads/)|
46
+
|**.NET SDK, Java, and P compiler**| Compiles and model-checks P programs |[**Follow the P installation guide**](https://p-org.github.io/P/getstarted/install/)|
47
+
48
+
> P requires a specific version of .NET SDK (8.0) and Java (≥ 11). The [P installation guide](https://p-org.github.io/P/getstarted/install/) has platform-specific instructions for macOS, Ubuntu, Amazon Linux, and Windows.
49
+
50
+
Verify your setup:
51
+
52
+
```bash
53
+
python3 --version # ≥ 3.10
54
+
dotnet --list-sdks # must show 8.0.*
55
+
java -version # ≥ 11
56
+
p --version # P compiler is on PATH
57
+
```
27
58
28
59
### Install PeasyAI
29
60
30
-
Install the latest release directly (no git clone required):
61
+
Install the latest release directly — **no git clone required**:
<summary><strong>Alternative: install from source</strong></summary>
76
+
<summary><strong>Alternative: install from source (for development)</strong></summary>
40
77
41
78
```bash
42
79
git clone https://github.com/p-org/P.git
@@ -46,7 +83,7 @@ pip install .
46
83
47
84
</details>
48
85
49
-
### Create your configuration
86
+
### Configure
50
87
51
88
```bash
52
89
peasyai-mcp init
@@ -243,7 +280,21 @@ The `peasy-ai-fix-compile-error` and `peasy-ai-fix-checker-error` tools try up t
243
280
244
281
---
245
282
246
-
## Running the MCP Server Standalone
283
+
## Troubleshooting
284
+
285
+
| Problem | Fix |
286
+
|---------|-----|
287
+
|`peasyai-mcp: command not found`| Make sure the pip install location is on your `PATH`. Try `python -m site --user-base` to find it, or use `pipx install` instead. |
288
+
|`p: command not found`| Install the P compiler following the [P installation guide](https://p-org.github.io/P/getstarted/install/) and ensure `~/.dotnet/tools` is on your `PATH`. |
289
+
|`dotnet: command not found`| Install .NET SDK 8.0 following the [P installation guide](https://p-org.github.io/P/getstarted/install/#step-1-install-net-core-sdk). |
290
+
| MCP server not showing in Cursor | Restart Cursor after editing `~/.cursor/mcp.json`. Check the MCP panel for error messages. |
291
+
| LLM calls failing | Run `peasyai-mcp config` to verify your credentials are loaded correctly. |
292
+
293
+
---
294
+
295
+
## Development
296
+
297
+
### Running the MCP Server Standalone
247
298
248
299
```bash
249
300
# Installed
@@ -254,18 +305,27 @@ cd Src/PeasyAI
254
305
.venv/bin/python -m ui.mcp.entry
255
306
```
256
307
257
-
## Streamlit Web App
308
+
###Streamlit Web App
258
309
259
310
```bash
260
311
cd Src/PeasyAI
261
312
pip install ".[streamlit]"
262
313
streamlit run src/app.py
263
314
```
264
315
265
-
## Running Tests
316
+
###Running Tests
266
317
267
318
```bash
268
319
cd Src/PeasyAI
269
320
make test-contracts # MCP contract tests
270
321
make regression # full regression suite
271
322
```
323
+
324
+
### Releasing a New Version
325
+
326
+
Tag the commit and push — GitHub Actions will build the wheel and create a release:
0 commit comments