chore(@supermemory/tools): fix the documentation of withSupermemory

[MaheshtheDev]

• small docs miss match on addMemory default option

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Updated (UTC)
✅ Deployment successful! View logs	supermemory-app	1ff6b7f	Dec 03 2025, 07:09 PM

[MaheshtheDev]

• chore(@supermemory/tools): fix the documentation of withSupermemory #601 👈 (View in Graphite)
• main

---

How to use the Graphite Merge Queue

Add the label Main to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[claude]

Code Review: Documentation Fix for withSupermemory

Summary

This PR correctly updates the JSDoc documentation for the withSupermemory function to accurately reflect the default values used in the implementation.

---

✅ Positive Feedback

Accurate Documentation

• The changes correctly align the JSDoc comments with the actual implementation in lines 63-64 of the code
• Default values are now properly documented:
  • mode: defaults to "profile" ✓
  • addMemory: defaults to "never" ✓

Code Quality

• Clean, focused change that improves documentation accuracy
• No functional code changes, reducing risk
• Follows the monorepo's conventions

---

📋 Observations

Current State

• The implementation (lines 63-64) uses:

  const mode = options?.mode ?? "profile"
  const addMemory = options?.addMemory ?? "never"

• Documentation now correctly matches this behavior

Impact

• This is a documentation-only change with zero risk to functionality
• Improves developer experience by providing accurate information
• Helps users understand the default behavior without reading implementation

---

✨ Suggestions (Minor)

1. Type Safety Enhancement (Future consideration)
   The WrapVercelLanguageModelOptions interface could optionally include default value annotations using JSDoc:

   interface WrapVercelLanguageModelOptions {
     conversationId?: string;
     /** @default false */
     verbose?: boolean;
     /** @default "profile" */
     mode?: "profile" | "query" | "full";
     /** @default "never" */
     addMemory?: "always" | "never";
   }

   This would make the defaults visible in IDEs when hovering over the interface definition.

2. Example Documentation
   The example in the JSDoc (lines 30-45) shows addMemory: "always" which is non-default. This is actually good as it demonstrates how to override the default, but you might consider adding a comment in the example explaining this.

---

🔒 Security & Performance

• No security concerns: Documentation-only change
• No performance impact: Zero runtime changes
• No breaking changes: Behavior remains identical

---

✅ Test Coverage

Not applicable - this is a documentation fix that doesn't require tests.

---

📊 Final Assessment

Verdict: LGTM 🚀

This is a clean, necessary fix that improves documentation accuracy. The change is minimal, focused, and correct.

Recommendation: ✅ Approve and merge

Great attention to detail in catching this documentation discrepancy!

[claude]

Pull Request Review

Summary

This PR correctly fixes a documentation mismatch in the JSDoc comments for the withSupermemory function. The previous documentation incorrectly stated the default values for mode and addMemory parameters.

✅ Changes Validated

Documentation Fix (packages/tools/src/vercel/index.ts:25-26)

• ✅ mode default: Changed from "profile" (default) to "profile", "query", or "full" (default: "profile")
  • Verified against implementation (line 63): const mode = options?.mode ?? "profile" ✓
• ✅ addMemory default: Changed from "always" (default) to "always", "never" (default: "never")
  • Verified against implementation (line 64): const addMemory = options?.addMemory ?? "never" ✓

Version Bump (packages/tools/package.json:4)

• ✅ Patch version bumped from 1.3.11 to 1.3.12 (appropriate for documentation fix)

Code Quality: ✅ Excellent

Strengths:

1. Accuracy: The documentation now correctly reflects the actual implementation defaults
2. Clarity: The new format clearly shows all possible values and explicitly states which is the default
3. Consistency: Maintains the same documentation style for both parameters
4. Test Coverage: Existing comprehensive test suite (550+ lines in test/vercel.test.ts) validates the implementation behavior
5. Version Management: Appropriate semver patch bump for documentation-only change

Security: ✅ No Concerns

• Documentation-only change with no security implications
• No code logic modified

Performance: ✅ No Impact

• Zero performance impact (documentation only)

Testing: ✅ Well Covered

The existing test suite thoroughly validates the middleware behavior:

• Environment validation tests (lines 64-84)
• Message extraction tests (lines 98-210)
• Memory injection tests (lines 212-303)
• Edge case handling (lines 429-549)
• Integration tests with real API (lines 378-427)

No new tests needed as only documentation was changed.

Best Practices: ✅ Follows Repository Standards

• ✅ Uses Biome for formatting (per CLAUDE.md)
• ✅ Follows TypeScript strict typing
• ✅ Maintains JSDoc documentation standards
• ✅ Appropriate version bump for documentation change

Recommendation: ✅ Approve and Merge

This is a straightforward documentation fix that improves accuracy and clarity. The changes are correct, well-scoped, and require no additional work.

Minor Suggestion (Optional - Not Blocking):
Consider also checking if the README.md needs similar clarification about default values for these parameters. The current README examples don't explicitly document the defaults, but that's acceptable for usage examples.

---

Review generated by Claude Code

[graphite-app]

[graphite-app]

Merge activity

• Dec 3, 6:59 PM UTC: MaheshtheDev added this pull request to the Graphite merge queue.
• Dec 3, 7:01 PM UTC: Merged by the Graphite merge queue.

[claude]

Code Review - PR #601

Summary

This PR fixes documentation inconsistencies in the withSupermemory function JSDoc comments. The changes correctly update the default values for addMemory option.

---

✅ Positive Aspects

1. Accurate Documentation Fix: The change correctly reflects the actual implementation defaults:

   • addMemory default is indeed "never" (line 64 in implementation)
   • mode default is indeed "profile" (line 63 in implementation)

2. Clear Documentation Format: The updated format explicitly states the default value in parentheses, making it immediately clear to users without having to check the code.

3. Version Bump: Appropriately incremented patch version from 1.3.11 to 1.3.12 for this documentation fix.

4. Consistency: Both parameters now follow the same documentation pattern.

---

📝 Observations

No issues found - This is a clean documentation fix that:

• Matches the implementation exactly (packages/tools/src/vercel/index.ts:64)
• Improves developer experience by clarifying defaults
• Follows semantic versioning appropriately
• Has minimal scope and low risk

---

✅ Code Quality Checklist

• ✅ Correctness: Documentation matches implementation
• ✅ Best Practices: Follows JSDoc conventions
• ✅ Security: N/A (documentation only)
• ✅ Performance: N/A (documentation only)
• ✅ Tests: N/A (documentation only, but existing tests remain valid)
• ✅ Breaking Changes: None

---

Recommendation

LGTM ✅ - This PR is ready to merge. It's a straightforward documentation fix that improves accuracy and developer experience.

---

Review generated by Claude Code reviewing packages/tools/src/vercel/index.ts:64