@tac0de/project-bootstrap-mcp 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,7 +45,40 @@ This project turns the MCP (Management Control Plane) bootstrap documentation in
|
|
|
45
45
|
- **Can the project goal be explained in one sentence?** Yes — “Expose MCP bootstrap docs as runnable API/CLI tooling ready for npm/GitHub distribution.”
|
|
46
46
|
- **Can success be evaluated without subjective judgment?** Yes — API functionality and `npm test` results provide objective verification.
|
|
47
47
|
|
|
48
|
-
##
|
|
48
|
+
## MCP Server Usage
|
|
49
|
+
|
|
50
|
+
### Installation
|
|
51
|
+
|
|
52
|
+
- `npm install -g project-bootstrap-mcp` (or `npm install project-bootstrap-mcp` for local use).
|
|
53
|
+
|
|
54
|
+
### Run (stdio)
|
|
55
|
+
|
|
56
|
+
- `project-bootstrap-mcp` (or `npm start`) launches the server on port 4000 unless overridden.
|
|
57
|
+
- Flags: `--port <number>` or `-p <number>` (or set the `PORT` env var) to change the listening port.
|
|
58
|
+
|
|
59
|
+
### Example MCP Client Config
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"command": "npx",
|
|
64
|
+
"args": ["-y", "project-bootstrap-mcp"]
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Tools
|
|
69
|
+
|
|
70
|
+
- `bootstrap_list` → `GET /api/bootstraps`
|
|
71
|
+
- `bootstrap_get` → `GET /api/bootstraps/:id`
|
|
72
|
+
- `bootstrap_create` → `POST /api/bootstraps`
|
|
73
|
+
- `service_status` → `GET /api/status`
|
|
74
|
+
|
|
75
|
+
### Documents
|
|
76
|
+
|
|
77
|
+
- `scope` → documents the allowed MCP actions and active MCPs (mirrors `examples/AGENTS.md`).
|
|
78
|
+
- `behavior` → describes feature behavior expectations in the README PRD section.
|
|
79
|
+
- `forbidden` → clarifies forbidden actions via the Agents contract (`contracts/agents.contract.md`).
|
|
80
|
+
- `contract` → references the PRD/TRD contract requirements.
|
|
81
|
+
- `bug_report_template` → placeholder for future debugging templates (add once defined).
|
|
49
82
|
|
|
50
83
|
### API Overview
|
|
51
84
|
|
|
@@ -56,7 +89,7 @@ This project turns the MCP (Management Control Plane) bootstrap documentation in
|
|
|
56
89
|
|
|
57
90
|
### CLI / Execution
|
|
58
91
|
|
|
59
|
-
- `
|
|
92
|
+
- `project-bootstrap-mcp` binary (installed globally) or `npm start` starts the server on port 4000 by default.
|
|
60
93
|
- Override the port with `--port` or `-p` (e.g., `project-bootstrap-mcp --port 5000`), or set the `PORT` environment variable.
|
|
61
94
|
|
|
62
95
|
### Testing & Validation
|