@schoolai/shipyard-mcp 0.2.2-next.482 → 0.2.2

package/apps/server/dist/index.js

@@ -4742,7 +4742,7 @@ var BUNDLED_DOCS = `Execute TypeScript code that calls Shipyard APIs. Use this f
 
 ## Available APIs
 
-### createPlan(opts): Promise<{ planId, sessionToken, url, deliverables, monitoringScript }>
+### createPlan(opts): Promise<{ planId, sessionToken, url, deliverables }>
 Create a new plan and open it in browser.
 
 Parameters:
@@ -4756,7 +4756,6 @@ Returns:
 - sessionToken: Required for subsequent API calls
 - url: Browser URL for the plan
 - deliverables: Array of { id, text } for linking artifacts
-- monitoringScript: Bash script to poll for approval (for non-hook agents)
 
 Example:
 \`\`\`typescript
@@ -4764,10 +4763,7 @@ const plan = await createPlan({
   title: "Add auth",
   content: "- [ ] Screenshot of login {#deliverable}"
 });
-// Returns: { planId: "abc", sessionToken: "xyz", url: "...", deliverables: [...], monitoringScript: "#!/bin/bash..." }
-
-// For non-hook agents: Run the monitoring script in background to wait for approval
-// bash <(echo "$monitoringScript") &
+// Returns: { planId: "abc", sessionToken: "xyz", url: "...", deliverables: [{ id: "del_xxx", text: "Screenshot of login" }] }
 \`\`\`
 
 ---
@@ -4805,7 +4801,7 @@ data.deliverables.forEach(d => console.log(d.id, d.completed));
 
 ---
 
-### updatePlan(planId, sessionToken, updates): Promise<{ success, monitoringScript }>
+### updatePlan(planId, sessionToken, updates): Promise<void>
 Update plan metadata.
 
 Parameters:
@@ -4814,10 +4810,6 @@ Parameters:
 - updates.title (string, optional): New title
 - updates.status (string, optional): 'draft' | 'pending_review' | 'changes_requested' | 'in_progress'
 
-Returns:
-- success: Boolean indicating update succeeded
-- monitoringScript: Bash script to poll for approval (for non-hook agents)
-
 Note: Most status transitions are automatic. Rarely needed.
 
 ---
@@ -4908,6 +4900,46 @@ Parameters:
 
 ---
 
+### setupReviewNotification(planId, pollIntervalSeconds?): Promise<{ script }>
+Get a bash script to poll for plan approval status changes.
+
+Parameters:
+- planId (string): Plan ID to monitor
+- pollIntervalSeconds (number, optional): Polling interval (default: 30)
+
+Returns:
+- script: Bash script that polls registry server and exits when status becomes 'in_progress' (approved) or 'changes_requested' (needs work)
+
+**IMPORTANT:** This is ONLY for agents WITHOUT hook support (Cursor, Devin, Windsurf, etc).
+Claude Code users have automatic blocking via the shipyard hook - you don't need this.
+
+**Complete workflow for non-hook agents (example user code):**
+\`\`\`typescript
+// 1. Create plan and get the monitoring script in ONE code block
+const plan = await createPlan({
+  title: "My Feature Implementation",
+  content: "- [ ] Screenshot of working feature {#deliverable}"
+});
+
+// 2. Get the polling script (returns bash script as string)
+const { script } = await setupReviewNotification(plan.planId, 15);
+
+// 3. Return both so the agent can run the script
+return {
+  planId: plan.planId,
+  sessionToken: plan.sessionToken,
+  monitoringScript: script,
+  instructions: "Run the monitoring script in background: bash <script> &"
+};
+\`\`\`
+
+The agent then runs the returned bash script in the background. The script will:
+- Poll the registry server every N seconds
+- Print status changes to stdout
+- Exit with code 0 when the plan is approved/rejected
+
+---
+
 ### requestUserInput(opts): Promise<{ success, response?, status, reason? }>
 Request input from the user via browser modal.
 
@@ -5043,9 +5075,7 @@ const plan = await createPlan({
   content: "- [ ] Screenshot {#deliverable}\\n- [ ] Video {#deliverable}"
 });
 
-// plan includes: planId, sessionToken, url, deliverables, monitoringScript
-// For non-hook agents: Run monitoringScript in background to wait for approval
-// The script polls and exits when human approves/rejects
+// plan.deliverables = [{ id: "del_xxx", text: "Screenshot" }, { id: "del_yyy", text: "Video" }]
 
 // Do work, take screenshots...
 
@@ -5085,13 +5115,11 @@ async function createPlan(opts) {
     const allDeliverables = getDeliverables(ydoc);
     deliverables = allDeliverables.map((d) => ({ id: d.id, text: d.text }));
   }
-  const { script: monitoringScript } = await setupReviewNotification(planId, 30);
   return {
     planId,
     sessionToken: text.match(/Session Token: (\S+)/)?.[1] || "",
     url: text.match(/URL: (\S+)/)?.[1] || "",
-    deliverables,
-    monitoringScript
+    deliverables
   };
 }
 async function readPlan(planId, sessionToken, opts) {
@@ -5121,11 +5149,6 @@ async function readPlan(planId, sessionToken, opts) {
 }
 async function updatePlan(planId, sessionToken, updates) {
   await updatePlanTool.handler({ planId, sessionToken, ...updates });
-  const { script: monitoringScript } = await setupReviewNotification(planId, 30);
-  return {
-    success: true,
-    monitoringScript
-  };
 }
 async function addArtifact2(opts) {
   const result = await addArtifactTool.handler(opts);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schoolai/shipyard-mcp",
-  "version": "0.2.2-next.482",
+  "version": "0.2.2",
   "description": "Shipyard MCP server and CLI tools for distributed planning with CRDTs",
   "type": "module",
   "bin": {