Skip to content

docs(cutline): streamline tool payload and refresh guides - #93

Merged
MyPrototypeWhat merged 1 commit into
MiniMax-AI:mainfrom
klarkxy:cutline-mcp-payload-docs
Oct 29, 2026
Merged

MyPrototypeWhat merged 1 commit into
MiniMax-AI:mainfrom
klarkxy:cutline-mcp-payload-docs

Conversation

@klarkxy

@klarkxy klarkxy commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Reduce MCP tool-description payload while preserving schemas and safety-critical behavior guidance; add a 16,000-byte regression guard.
  • Refresh the Cutline README, bilingual screenshots, skill references, and patch provenance; align package metadata at v0.1.1.
  • Clarify shared-project behavior and local file access boundaries in both READMEs.

Validation

ode scripts/validate.mjs plugins/klarkxy/cutline — pass.

pm test in plugins/klarkxy/cutline — 171 passed, 23 skipped, 0 failed (skips require FFmpeg or symlink permissions unavailable in this environment).

ode --test tests/mcp-tool-payload.test.mjs — 4 passed.

pm run check — repository validation passed; 85/87 tests passed. The two failures are Windows symlink fixtures failing with EPERM in the temp directory.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

@MyPrototypeWhat MyPrototypeWhat left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. Approving. I reviewed fab8972 and found nothing that needs to change before merge.

Scope

  • Everything except the two root READMEs stays under plugins/klarkxy/cutline/. .github/, the root scripts/, the root test/ and the root package.json are unchanged.
  • In README.md and README.zh-CN.md, the PR rewords the Cutline catalog row and adds a collapsible "Preview: Cutline" block that uses the plugin's own screenshots. That block follows the existing preview blocks, such as the one for Token Usage Board, and contains only Cutline content. I'm fine keeping it in this PR.

MCP tool payload

  • The mcp-server.js diff touches only description strings. The tool names, inputSchema properties, types, enums, required lists and handlers are the same as on main. The same goes for export-mcp.mjs: only EXPORT_TOOL's description text changed.
  • The shorter descriptions still name the required parameters (baseRevision is still marked REQUIRED on fablecut_set_project, and folder is still required for fablecut_import_project). They also keep the main behavioral warnings: the CONFLICT behavior, force used only on request, headless refused, and the ffmpeg/ffprobe and Chrome/Edge requirements for export.
  • The detailed op catalog for fablecut_patch_project now lives in fablecut_docs (the "MCP connection" and schema sections) and in the slimmer skill references, and the tool description points agents there. That tradeoff seems reasonable.
  • Optional: keep a one-line reminder in the patch description that the patch is all-or-nothing and that locked clips are refused unless force is passed, so an agent that skips the docs still knows both rules.
  • tests/mcp-tool-payload.test.mjs stays inside the plugin and runs through the plugin's own npm test. It is not wired into repo CI. It reads the live tools/list through the existing test helpers and adds no new file, network or credential access.

Versions
plugin.json, package.json and upstream.json all say 0.1.1, and PATCHES.md describes the changes.

Checks (Node 22)

  • npm run check at the repo root: 87 pass, 0 fail (Linux).
  • Plugin npm test: 194 tests, 181 pass, 13 skipped, 0 fail.
  • The two Windows EPERM failures come from test/files.test.mjs, which creates symlinks on purpose. This PR doesn't touch that file, so they aren't caused by it. From the code, main should fail the same way on Windows when the account can't create symlinks (no Developer Mode or admin rights). I didn't run it on Windows.

@MyPrototypeWhat
MyPrototypeWhat merged commit 1dcad75 into MiniMax-AI:main Oct 29, 2026
1 check passed
@klarkxy
klarkxy deleted the cutline-mcp-payload-docs branch October 31, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants