Skip to content

Document AI-optimized mutation workflows#56

Merged
deverman merged 1 commit into
masterfrom
issue-36-docs-ai-guidance
Jun 2, 2026
Merged

Document AI-optimized mutation workflows#56
deverman merged 1 commit into
masterfrom
issue-36-docs-ai-guidance

Conversation

@deverman

@deverman deverman commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Summary

Closes #36.

Adds user-facing docs for the shipped v1 mutation surface:

  • new docs/mutation-workflows.md with CLI and MCP routing guidance
  • README examples and mutation tool overview
  • docs/use-cases.md status refresh so shipped write tools are no longer described as future
  • write contract link to the workflow companion doc

Notes

The docs emphasize the locked v1 constraints:

  • ID-only mutation targeting
  • homogeneous bulk writes only
  • patch vs lifecycle/status vs move tool split
  • previewOnly, verify, and compact returnFields
  • explicit out-of-scope items including mixed batch_mutate_tasks, create/delete tools, planned-date writes, and folder discovery

Validation

  • git diff --check
  • swift test passed: 95 Swift Testing tests

@deverman deverman merged commit e88647a into master Jun 2, 2026
1 check passed
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.

Document AI-Optimized Mutation Workflows for CLI and MCP

1 participant