Repository navigation
docs(docs): refresh AGENTS.md to match the code - #41
Merged
Merged
Conversation
The MCP server ships, src/preview/, examples/ and tests/integration/ don't exist, and sharp isn't a dependency. List the mcp, ui, session and storage modules. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Describe the MCP server, UI and build stack; workspace confinement as implemented (UI/MCP confined, CLI relative to cwd); tool result shapes; the probe.ts execa exception; and CI's build step. Replace the unused `preview` scope with `ui` and drop the nonexistent tests/integration. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
🎉 This PR is included in version 0.3.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Brings AGENTS.md, and the parts of CONTRIBUTING.md that repeat it, in line with the code on
main.AGENTS.md
src/mcp/server.tsstarted byclip mcp.src/preview/andexamples/;src/mcp,src/ui,src/session,src/storage,src/workspace.ts,src/cli-timeline.tsandsrc/index.ts;timeline/as the composition document.sharp, which isn't a dependency;$MAKEMYCLIP_FFMPEG_PATHoverrides the bundled binary, and systemffmpegis the last fallback.clip uiand MCP paths are confined viaresolveInWorkspace, while CLI paths resolve against the current directory.@makemyclip/generationdoesn't exist yet.PascalCase.tsx/useX.tsfiles, and that config files need a default export.ingest,inspect,split,undoanddelete-opdon't return{ path };clip timelineis wired insrc/cli-timeline.ts, and the UI exposes tools throughsrc/ui/tool-registry.ts;probe.tsis the one directexecacaller;compile.tsbuilds its own filter graphs.type-checkcovers both tsconfigs, and CI also runspnpm build;tests/integration/line, since that directory doesn't exist.styletype, and replace the unusedpreviewscope withui.uiis the most-used scope in history (18 commits);previewhas none.CONTRIBUTING.md
uiscope (including the example), handler result shapes, the timeline source of truth and schema location, generation "will live", the CI build step, and the droppedtests/integration/line.src/mcp/server.ts, notsrc/tools/.Backlog: add
docs/backlog/cli-input-validation.md.src/cli.tsnever runs a tool's Zod*Input.parse, so CLI arguments reach the arg builders unvalidated.CLAUDE.md is just
@AGENTS.md; no change needed.Why
AGENTS.md is what agents read first, and it described a project shape from before the MCP server, UI and timeline engine shipped.
Not changed (needs a decision)
ffmpeg-static. The rule bans GPL npm packages, butffmpeg-static's own package.json declaresGPL-3.0-or-later. The rule's text only covers the FFmpeg binary.mainuse lowercase.is*/has*boolean names, and handler idempotency (output paths use a random id). These are left as rules; the code doesn't fully comply.Checks
origin/main(d4ad0fe): file paths,*Resultinterfaces insrc/tools/,execa,resolveInputandresolveInWorkspacecall sites,package.jsonscripts,ci.yml,.parse(sites, and the commit-scope counts ingit log.origin/main. I verified and fixed its findings: workspace confinement, theinspectresult shape, FFmpeg resolution order, the builder count, the missingstyletype and the "MCP tools" heading. The items it raised that need a decision are listed above, unchanged.