@ourroadmaps/mcp 0.11.0 → 0.13.0

package/README.md

@@ -0,0 +1,30 @@
+# @ourroadmaps/mcp
+
+MCP server for OurRoadmaps - manage roadmaps, features, and ideas from Claude Code.
+
+## Installation
+
+```bash
+claude mcp add roadmaps \
+  --env ROADMAPS_API_URL=https://api.ourroadmaps.com \
+  --env ROADMAPS_API_KEY=your-key-here \
+  -- npx -y @ourroadmaps/mcp
+```
+
+Get your API key from **Organization Settings → API Keys** in the web app.
+
+## Development
+
+This package is published to npm. Changes require publishing:
+
+```bash
+bun run build
+# bump version in package.json
+npm publish
+```
+
+The server runs from npm, not local files. Users fetch via `npx -y @ourroadmaps/mcp`.
+
+## Available Tools
+
+See the main [README](../../README.md#mcp-server) for the full list of tools.

package/dist/index.js

@@ -794,6 +794,34 @@ class ApiClient {
       method: "DELETE"
     });
   }
+  async getDesignWalkthroughUploadUrl(data) {
+    const response = await this.request("/v1/designs/walkthrough/upload-url", {
+      method: "POST",
+      body: JSON.stringify(data)
+    });
+    return response.data;
+  }
+  async updateDesignWalkthrough(roadmapId, walkthroughVideoUrl) {
+    const response = await this.request(`/v1/designs/roadmaps/${roadmapId}/design`, {
+      method: "PATCH",
+      body: JSON.stringify({ walkthroughVideoUrl })
+    });
+    return response.data;
+  }
+  async getReleaseWalkthroughUploadUrl(data) {
+    const response = await this.request("/v1/releases/walkthrough/upload-url", {
+      method: "POST",
+      body: JSON.stringify(data)
+    });
+    return response.data;
+  }
+  async updateReleaseWalkthrough(roadmapId, walkthroughVideoUrl) {
+    const response = await this.request(`/v1/releases/roadmaps/${roadmapId}/release`, {
+      method: "PATCH",
+      body: JSON.stringify({ walkthroughVideoUrl })
+    });
+    return response.data;
+  }
   async getProductDesignUploadUrl(productId, data) {
     const response = await this.request(`/v1/products/${productId}/design-media/upload-url`, {
       method: "POST",
@@ -922,6 +950,8 @@ function registerAllTools(server) {
   registerUploadProductDesignMedia(server);
   registerUpdateProductDesignMedia(server);
   registerDeleteProductDesignMedia(server);
+  registerUploadDesignWalkthrough(server);
+  registerUploadReleaseWalkthrough(server);
 }
 function registerSearchRoadmaps(server) {
   server.registerTool("search_roadmaps", {
@@ -1290,7 +1320,8 @@ function registerUpdateRoadmapItem(server) {
       designDescription: z10.string().nullable().optional().describe("Description for the Design phase"),
       planDescription: z10.string().nullable().optional().describe("Description for the Planning phase"),
       buildDescription: z10.string().nullable().optional().describe("Description for the Build phase"),
-      releaseDescription: z10.string().nullable().optional().describe("Description for the Release phase")
+      releaseDescription: z10.string().nullable().optional().describe("Description for the Release phase"),
+      prompt: z10.string().nullable().optional().describe("Build prompt for the roadmap item")
     }
   }, async ({
     id,
@@ -1303,7 +1334,8 @@ function registerUpdateRoadmapItem(server) {
     designDescription,
     planDescription,
     buildDescription,
-    releaseDescription
+    releaseDescription,
+    prompt
   }) => {
     const client2 = getApiClient();
     const updates = {};
@@ -1319,7 +1351,7 @@ function registerUpdateRoadmapItem(server) {
       updates.effort = effort;
     if (order !== undefined)
       updates.order = order;
-    const roadmap2 = await client2.updateRoadmap(id, updates);
+    const roadmap2 = Object.keys(updates).length > 0 ? await client2.updateRoadmap(id, updates) : await client2.getRoadmap(id);
     const phaseUpdates = {};
     if (designDescription !== undefined) {
       await client2.updateDesignDescription(id, designDescription);
@@ -1329,9 +1361,17 @@ function registerUpdateRoadmapItem(server) {
       await client2.updatePlanDescription(id, planDescription);
       phaseUpdates.planDescription = planDescription;
     }
-    if (buildDescription !== undefined) {
-      await client2.updateBuildDescription(id, { description: buildDescription });
-      phaseUpdates.buildDescription = buildDescription;
+    if (buildDescription !== undefined || prompt !== undefined) {
+      const buildData = {};
+      if (buildDescription !== undefined)
+        buildData.description = buildDescription;
+      if (prompt !== undefined)
+        buildData.prompt = prompt;
+      await client2.updateBuildDescription(id, buildData);
+      if (buildDescription !== undefined)
+        phaseUpdates.buildDescription = buildDescription;
+      if (prompt !== undefined)
+        phaseUpdates.prompt = prompt;
     }
     if (releaseDescription !== undefined) {
       await client2.updateReleaseDescription(id, releaseDescription);
@@ -2685,6 +2725,95 @@ function registerDeleteProductDesignMedia(server) {
     };
   });
 }
+function isVideoContentType(contentType) {
+  return contentType?.startsWith("video/") ?? false;
+}
+function registerUploadDesignWalkthrough(server) {
+  server.registerTool("upload_design_walkthrough", {
+    description: "Upload a walkthrough video to a roadmap item's design phase. Returns a curl command to execute for the upload.",
+    inputSchema: {
+      roadmapId: z10.string().describe("The UUID of the roadmap item"),
+      filePath: z10.string().describe("Absolute path to the video file on disk")
+    }
+  }, async ({ roadmapId, filePath }) => {
+    const client2 = getApiClient();
+    const filename = filePath.split("/").pop() || "video.mp4";
+    const contentType = inferContentType(filename);
+    if (!isVideoContentType(contentType)) {
+      return {
+        content: [
+          {
+            type: "text",
+            text: JSON.stringify({
+              error: "Unsupported video format. Use MP4, WebM, or MOV."
+            })
+          }
+        ]
+      };
+    }
+    const { uploadUrl, videoUrl } = await client2.getDesignWalkthroughUploadUrl({
+      filename,
+      contentType
+    });
+    await client2.updateDesignWalkthrough(roadmapId, videoUrl);
+    const curlCommand = `curl -X PUT -H "Content-Type: ${contentType}" --data-binary @"${filePath}" "${uploadUrl}"`;
+    return {
+      content: [
+        {
+          type: "text",
+          text: JSON.stringify({
+            videoUrl,
+            curlCommand,
+            instructions: "Execute the curlCommand to upload the video. The design record has been updated and will display once uploaded."
+          }, null, 2)
+        }
+      ]
+    };
+  });
+}
+function registerUploadReleaseWalkthrough(server) {
+  server.registerTool("upload_release_walkthrough", {
+    description: "Upload a walkthrough video to a roadmap item's release phase. Returns a curl command to execute for the upload.",
+    inputSchema: {
+      roadmapId: z10.string().describe("The UUID of the roadmap item"),
+      filePath: z10.string().describe("Absolute path to the video file on disk")
+    }
+  }, async ({ roadmapId, filePath }) => {
+    const client2 = getApiClient();
+    const filename = filePath.split("/").pop() || "video.mp4";
+    const contentType = inferContentType(filename);
+    if (!isVideoContentType(contentType)) {
+      return {
+        content: [
+          {
+            type: "text",
+            text: JSON.stringify({
+              error: "Unsupported video format. Use MP4, WebM, or MOV."
+            })
+          }
+        ]
+      };
+    }
+    const { uploadUrl, videoUrl } = await client2.getReleaseWalkthroughUploadUrl({
+      filename,
+      contentType
+    });
+    await client2.updateReleaseWalkthrough(roadmapId, videoUrl);
+    const curlCommand = `curl -X PUT -H "Content-Type: ${contentType}" --data-binary @"${filePath}" "${uploadUrl}"`;
+    return {
+      content: [
+        {
+          type: "text",
+          text: JSON.stringify({
+            videoUrl,
+            curlCommand,
+            instructions: "Execute the curlCommand to upload the video. The release record has been updated and will display once uploaded."
+          }, null, 2)
+        }
+      ]
+    };
+  });
+}
 
 // src/index.ts
 async function main() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ourroadmaps/mcp",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "MCP server for OurRoadmaps - manage roadmaps, features, and ideas from Claude Code",
   "type": "module",
   "bin": {