Skip to content

Commit a6867db

Browse files
committed
document mcp runtime dependencies
1 parent 7dd1333 commit a6867db

4 files changed

Lines changed: 21 additions & 3 deletions

File tree

.codex-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "specx-codex-plugin",
3-
"version": "0.2.1",
3+
"version": "0.2.2",
44
"description": "Universal spec-driven agent governance and execution contract runtime for Codex.",
55
"license": "MIT",
66
"author": {

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ codex plugin marketplace add BTCNAI/specx-codex-marketplace
1717
Or pin the stable release:
1818

1919
```bash
20-
codex plugin marketplace add https://github.com/BTCNAI/specx-codex-marketplace.git --ref v0.2.1
20+
codex plugin marketplace add https://github.com/BTCNAI/specx-codex-marketplace.git --ref v0.2.2
2121
```
2222

2323
## What It Provides
@@ -55,6 +55,12 @@ Included MCP tools:
5555
- `specx.verify`
5656
- `specx.explain`
5757

58+
Install MCP runtime dependencies before running MCP tools:
59+
60+
```bash
61+
python3 -m pip install -r requirements.txt
62+
```
63+
5864
## Contract Shape
5965

6066
Every valid contract must define:

docs/mcp-tools.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ Each tool accepts a SpecX contract JSON object as `contract`.
1111

1212
## Local Server
1313

14+
Install runtime dependencies:
15+
16+
```bash
17+
python3 -m pip install -r requirements.txt
18+
```
19+
1420
The plugin manifest registers:
1521

1622
```json

docs/quickstart.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,17 @@ codex plugin marketplace add BTCNAI/specx-codex-marketplace
1111
Pinned install:
1212

1313
```bash
14-
codex plugin marketplace add https://github.com/BTCNAI/specx-codex-marketplace.git --ref v0.2.1
14+
codex plugin marketplace add https://github.com/BTCNAI/specx-codex-marketplace.git --ref v0.2.2
1515
```
1616

1717
## Validate A Contract
1818

19+
Install MCP runtime dependencies before using MCP tools:
20+
21+
```bash
22+
python3 -m pip install -r requirements.txt
23+
```
24+
1925
```bash
2026
python3 scripts/specx_cli.py validate examples/demo_software_engineering_contract.json
2127
```

0 commit comments

Comments
 (0)