@el4cteo/rbx-studio-mcp 0.7.8 → 0.8.2

package/dist/tools/anim.js

@@ -1,159 +0,0 @@
-import { z } from "zod";
-import { json, table, text, textOf } from "../lib/format.js";
-import { defineTool } from "../lib/tool.js";
-/** Downloads go to Roblox's asset servers, which are not always quick. */
-const TIMEOUT_MS = 45_000;
-export function registerAnimTools(context) {
-    const { bridge } = context;
-    defineTool(context, {
-        name: "animation",
-        title: "Read and build animations",
-        description: "Reads an animation's actual keyframes, and builds new ones that play " +
-            "immediately in the open Studio.\n\n" +
-            "Animations are the one part of a place no other tool can see. " +
-            "`inspect` on an Animation instance returns an asset id and stops there " +
-            "— the poses live on Roblox's servers. `read` downloads them, so you can " +
-            "answer 'how long is it', 'which joints does it move', and 'does it end " +
-            "where it started' without opening the Animation Editor and scrubbing.\n\n" +
-            "`read` takes an asset id, an rbxassetid:// string, or the path of an " +
-            "Animation instance in the place — whichever you already have. It reports " +
-            "which RIG the animation was made for, which is the thing most worth " +
-            "knowing: an R15 animation on an R6 character does nothing at all — no " +
-            "error, no movement — and the asset id gives no hint either way.\n\n" +
-            "`build` goes the other way: give it keyframes and it returns a content " +
-            "id you can put straight into an Animation's AnimationId. Nothing is " +
-            "uploaded and nothing is moderated — the id works in this Studio session " +
-            "and nowhere else, which makes it the right way to try an idea and the " +
-            "wrong way to ship one.\n\n" +
-            "`preview` puts an animation ONTO a rig in the open place and freezes it " +
-            "at a chosen moment, so `screenshot` can show you the pose. It works in " +
-            "edit mode — no playtest. Ask for several moments in turn to compare " +
-            "poses across the animation; the rig stays posed until `stop`.\n\n" +
-            "Poses are written the way a CFrame property is: \"0, 1, 0\" for a " +
-            "position, \"0, 1, 0 | 0, 45, 0\" to rotate as well.\n\n" +
-            "The id `build` returns is a bare hash, not an rbxassetid:// URL. Use it " +
-            "exactly as given — prefixing it stops it working.",
-        inputSchema: {
-            op: z
-                .enum(["read", "preview", "build", "stop"])
-                .default("read")
-                .describe("'read' downloads an existing animation, 'preview' poses a rig at one " +
-                "moment of it so you can screenshot it, 'build' makes a new one " +
-                "playable here, 'stop' clears a preview."),
-            assetId: z
-                .union([z.number(), z.string()])
-                .optional()
-                .describe('read only: animation asset id (12345), "rbxassetid://12345", or the ' +
-                'path of an Animation instance ("Workspace.Rig.Animate.run").'),
-            keyframes: z
-                .array(z.object({
-                time: z.number().min(0).describe("Seconds from the start of the animation."),
-                name: z.string().optional().describe('Keyframe name, e.g. "Start" or a marker name.'),
-                poses: z
-                    .record(z.string(), z.string())
-                    .optional()
-                    .describe('Joint name → CFrame, e.g. { "Right Arm": "0, 0.5, 0 | 0, 0, 45" }. ' +
-                    "Joint names must match the rig's parts."),
-            }))
-                .max(200)
-                .optional()
-                .describe("build only: the keyframes, in any order — they are sorted by time."),
-            name: z.string().optional().describe("build only: name for the sequence."),
-            root: z
-                .string()
-                .optional()
-                .describe('build only: the rig part every pose hangs from. Defaults to "HumanoidRootPart", ' +
-                "which is right for an R15 or R6 character."),
-            priority: z
-                .enum(["Idle", "Movement", "Action", "Core"])
-                .optional()
-                .describe("build only: which animations this one plays over."),
-            loop: z.boolean().optional().describe("build only: whether it repeats."),
-            rig: z
-                .string()
-                .optional()
-                .describe('The model, e.g. "Workspace.Dummy". For preview/stop it is the rig to ' +
-                "pose, and needs a Humanoid or an AnimationController inside it. For " +
-                "`build` it is optional and is read for its joint layout — pass it for " +
-                "anything that is not a standard R6 or R15 character (a custom rig, a " +
-                "weapon, a door, a Blender import), or the poses may be attached in the " +
-                "wrong order and the animation will move nothing."),
-            at: z
-                .number()
-                .min(0)
-                .optional()
-                .describe("preview only: the moment to freeze on, in seconds. Ask for several " +
-                "in turn to compare poses across the animation."),
-            hold: z
-                .boolean()
-                .default(true)
-                .describe("preview only: freeze on that frame. Turn off to let it play, but then " +
-                "a screenshot catches whatever pose it happens to be in."),
-            studioId: z.string().optional().describe("Target Studio; omit for the active one."),
-        },
-        readOnly: false,
-        destructive: false,
-    }, async (args) => {
-        if (args.op === "preview" || args.op === "stop") {
-            if (!args.rig)
-                return text("preview needs a `rig` — the model to pose.");
-            const posed = await bridge.call("anim.preview", { op: args.op, rig: args.rig, assetId: args.assetId, at: args.at, hold: args.hold }, { studioId: args.studioId, timeoutMs: TIMEOUT_MS });
-            return json(posed);
-        }
-        if (args.op === "build") {
-            if (!args.keyframes || args.keyframes.length === 0) {
-                return text("build needs a non-empty `keyframes` array.");
-            }
-            const built = await bridge.call("anim.build", {
-                keyframes: args.keyframes,
-                name: args.name,
-                root: args.root,
-                rig: args.rig,
-                priority: args.priority,
-                loop: args.loop,
-            }, { studioId: args.studioId, timeoutMs: TIMEOUT_MS });
-            return json(built, "Set this as an Animation's AnimationId with `modify`, exactly as it appears " +
-                "— it is a bare hash, and adding rbxassetid:// in front of it stops it " +
-                "working. Local to this Studio session: not uploaded, gone on restart.\n\n" +
-                "`hierarchy` says which joint layout the poses were nested against — the " +
-                "rig you named, or the R6/R15 standard guessed from the joint names. " +
-                "Anything in `unmatchedJoints` is a name that layout does not contain: " +
-                "those poses were attached to the root and will almost certainly do " +
-                "nothing. Pass `rig` to fix it.");
-        }
-        if (args.assetId === undefined) {
-            return text("read needs an `assetId` — a number, an rbxassetid:// string, or a path to an Animation.");
-        }
-        const found = await bridge.call("anim.read", { assetId: args.assetId }, { studioId: args.studioId, timeoutMs: TIMEOUT_MS });
-        /*
-         * A summary first, then the timeline. The three facts at the top are what
-         * the question was, and burying them under forty rows of keyframes would
-         * make the tool technically complete and practically unreadable.
-         */
-        const lines = [
-            `${found.name ?? found.assetId} — ${found.rig} rig, ${found.duration}s, ` +
-                `${found.keyframeCount} keyframes, ${found.jointCount} joints moved`,
-            `Priority ${found.priority}${found.looping ? ", loops" : ", does not loop"}` +
-                (found.rigNote !== undefined ? ` — ${found.rigNote}` : ""),
-            "",
-            `Joints: ${found.joints.join(", ") || "none"}` +
-                (found.jointsSampled ? ` … and ${found.jointCount - found.joints.length} more` : ""),
-        ];
-        if (found.rig === "R6" || found.rig === "R15") {
-            lines.push("", `This is an ${found.rig} animation. It will do NOTHING on an ${found.rig === "R6" ? "R15" : "R6"} character — no error, no movement, because the joint names do not exist ` +
-                "on the other rig. Check the character's rig type before using it.");
-        }
-        if (found.looping && found.endsWhereItStarted === false) {
-            lines.push("", "WARNING: this animation loops, but these joints do not end where they " +
-                `started: ${(found.driftingJoints ?? []).join(", ")}. That is what a ` +
-                "visible jump at the loop point looks like.");
-        }
-        lines.push("", textOf(table(["index", "time", "name", "poseCount"], found.keyframes, {
-            more: found.truncated
-                ? `poses expanded for the first 40 keyframes only`
-                : undefined,
-        })));
-        return text(lines.join("\n"));
-    });
-}
-//# sourceMappingURL=anim.js.map

package/dist/tools/anim.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"anim.js","sourceRoot":"","sources":["../../src/tools/anim.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAmB,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAoB,MAAM,gBAAgB,CAAC;AA2B9D,0EAA0E;AAC1E,MAAM,UAAU,GAAG,MAAM,CAAC;AAE1B,MAAM,UAAU,iBAAiB,CAAC,OAAoB;IACpD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE3B,UAAU,CACR,OAAO,EACP;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,2BAA2B;QAClC,WAAW,EACT,uEAAuE;YACvE,qCAAqC;YACrC,gEAAgE;YAChE,yEAAyE;YACzE,0EAA0E;YAC1E,yEAAyE;YACzE,2EAA2E;YAC3E,uEAAuE;YACvE,2EAA2E;YAC3E,sEAAsE;YACtE,wEAAwE;YACxE,qEAAqE;YACrE,yEAAyE;YACzE,sEAAsE;YACtE,0EAA0E;YAC1E,wEAAwE;YACxE,4BAA4B;YAC5B,0EAA0E;YAC1E,yEAAyE;YACzE,sEAAsE;YACtE,mEAAmE;YACnE,oEAAoE;YACpE,yDAAyD;YACzD,0EAA0E;YAC1E,mDAAmD;QACrD,WAAW,EAAE;YACX,EAAE,EAAE,CAAC;iBACF,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;iBAC1C,OAAO,CAAC,MAAM,CAAC;iBACf,QAAQ,CACP,uEAAuE;gBACrE,iEAAiE;gBACjE,yCAAyC,CAC5C;YACH,OAAO,EAAE,CAAC;iBACP,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;iBAC/B,QAAQ,EAAE;iBACV,QAAQ,CACP,sEAAsE;gBACpE,8DAA8D,CACjE;YACH,SAAS,EAAE,CAAC;iBACT,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;gBACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,0CAA0C,CAAC;gBAC5E,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+CAA+C,CAAC;gBACrF,KAAK,EAAE,CAAC;qBACL,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;qBAC9B,QAAQ,EAAE;qBACV,QAAQ,CACP,qEAAqE;oBACnE,yCAAyC,CAC5C;aACJ,CAAC,CACH;iBACA,GAAG,CAAC,GAAG,CAAC;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,oEAAoE,CAAC;YACjF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;YAC1E,IAAI,EAAE,CAAC;iBACJ,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,kFAAkF;gBAChF,4CAA4C,CAC/C;YACH,QAAQ,EAAE,CAAC;iBACR,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;iBAC5C,QAAQ,EAAE;iBACV,QAAQ,CAAC,mDAAmD,CAAC;YAChE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;YACxE,GAAG,EAAE,CAAC;iBACH,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,uEAAuE;gBACrE,sEAAsE;gBACtE,wEAAwE;gBACxE,uEAAuE;gBACvE,yEAAyE;gBACzE,kDAAkD,CACrD;YACH,EAAE,EAAE,CAAC;iBACF,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,EAAE;iBACV,QAAQ,CACP,qEAAqE;gBACnE,gDAAgD,CACnD;YACH,IAAI,EAAE,CAAC;iBACJ,OAAO,EAAE;iBACT,OAAO,CAAC,IAAI,CAAC;iBACb,QAAQ,CACP,wEAAwE;gBACtE,yDAAyD,CAC5D;YACH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;SACpF;QACD,QAAQ,EAAE,KAAK;QACf,WAAW,EAAE,KAAK;KACnB,EACD,KAAK,EAAE,IAAI,EAAuB,EAAE;QAClC,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,GAAG;gBAAE,OAAO,IAAI,CAAC,4CAA4C,CAAC,CAAC;YACzE,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAC7B,cAAc,EACd,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EACnF,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CACnD,CAAC;YACF,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnD,OAAO,IAAI,CAAC,4CAA4C,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAC7B,YAAY,EACZ;gBACE,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,EACD,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CACnD,CAAC;YACF,OAAO,IAAI,CACT,KAAK,EACL,8EAA8E;gBAC5E,wEAAwE;gBACxE,2EAA2E;gBAC3E,0EAA0E;gBAC1E,sEAAsE;gBACtE,wEAAwE;gBACxE,qEAAqE;gBACrE,gCAAgC,CACnC,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,yFAAyF,CAAC,CAAC;QACzG,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAC7B,WAAW,EACX,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EACzB,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,CACnD,CAAC;QAEF;;;;WAIG;QACH,MAAM,KAAK,GAAG;YACZ,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,MAAM,KAAK,CAAC,GAAG,SAAS,KAAK,CAAC,QAAQ,KAAK;gBACvE,GAAG,KAAK,CAAC,aAAa,eAAe,KAAK,CAAC,UAAU,eAAe;YACtE,YAAY,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,EAAE;gBAC1E,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,EAAE;YACF,WAAW,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,EAAE;gBAC5C,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;SACvF,CAAC;QAEF,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,EAAE,CAAC;YAC9C,KAAK,CAAC,IAAI,CACR,EAAE,EACF,cAAc,KAAK,CAAC,GAAG,wCACrB,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAC/B,2EAA2E;gBACzE,mEAAmE,CACtE,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,kBAAkB,KAAK,KAAK,EAAE,CAAC;YACxD,KAAK,CAAC,IAAI,CACR,EAAE,EACF,wEAAwE;gBACtE,YAAY,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB;gBACtE,4CAA4C,CAC/C,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,IAAI,CACR,EAAE,EACF,MAAM,CACJ,KAAK,CACH,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EACtC,KAAK,CAAC,SAAsD,EAC5D;YACE,IAAI,EAAE,KAAK,CAAC,SAAS;gBACnB,CAAC,CAAC,gDAAgD;gBAClD,CAAC,CAAC,SAAS;SACd,CACF,CACF,CACF,CAAC;QAEF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAChC,CAAC,CACF,CAAC;AACJ,CAAC"}