Skip to content

Add MCP client onboarding and staged-edit walkthrough #23

Description

@alonshoa

Problem

The MCP documentation lists resources, tools, and the staged-edit safety model, but it does not yet walk a user through a complete human-readable scenario from client configuration to reviewing and applying a staged scene edit.

Scope

  • Add a tutorial for connecting an MCP client to Manim Studio.
  • Include portable local/devcontainer and Docker-backed external-project configuration examples.
  • Show a complete staged-edit workflow:
    • inspect scene context
    • propose a patch
    • inspect the diff
    • validate the staged scene
    • draft-render the staged proposal
    • apply only after explicit approval
  • Explain which operations are read-only, which create staged artifacts, and which modify canonical source.
  • Keep safety boundaries user-facing and concrete rather than only maintainer-oriented.

Acceptance Criteria

  • A user can configure an MCP client without repository-specific paths hard-coded into the only example.
  • The staged-edit walkthrough uses currently implemented MCP tools.
  • The docs clearly state that MCP does not expose unrestricted shell access or direct arbitrary file editing.
  • Stdio startup is verified in the intended runtime/devcontainer environment or the remaining verification gap is explicitly documented.
  • mkdocs build --strict passes.

Dependencies

Depends on verifying installed stdio startup status and reviewing the remaining scope in #15.

Category

documentation, mcp, onboarding

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions