Commit graph

65 commits

Author SHA1 Message Date
Dhravya Shah
48167c3246 docs: fix production build breaker — HTML comments are invalid MDX
71 '<!-- CONFIRM -->' review markers across 19 files used HTML comment
syntax, which MDX cannot parse. One parse error breaks the whole
production build — this is why the deployed site 404'd on every page
while local dev limped along. All converted to {/* */} (code-fence
contents untouched). Also: remove the legacy source-'/' redirect,
replace the phantom architecture-diagram image with an ASCII diagram
until the real one lands.

Verified locally: mintlify broken-links parses all pages clean (one
known-good /api-reference tab link that 307s at runtime), and /,
/overview, /concepts/architecture, /quickstart, /patterns/*,
/versioning all render 200 with content.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:47:05 -07:00
Dhravya Shah
7d3993f0da docs: decluttered card-based home, fix /overview folder collision
/ resolved into overview/use-cases because both overview.mdx and the
overview/ directory existed — move use-cases to /use-cases (redirected)
and remove the folder. Rewrite the landing as a mem0-style home: one
paragraph, the two-call loop, then card grids (start here / pick your
door / go deep / why) instead of the long-form pitch.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:33:20 -07:00
Dhravya Shah
b8f90929bd docs: fix redirect loop — land on /overview, root redirects there once
Serving the landing at / via an index page loops on Mintlify hosting
(/ -> first nav page /index -> normalized back to /). Use the /overview
slug instead: / redirects there once via Mintlify's built-in behavior,
/intro and legacy intro paths redirect to /overview, no destination is
bare / anymore.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:30:16 -07:00
Dhravya Shah
f6fd0210af docs: serve the landing page at the root instead of redirecting to /intro
Rename intro.mdx to index.mdx so Mintlify serves it at / directly; /intro
redirects to /, old redirect destinations follow, internal links updated.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:27:59 -07:00
Dhravya Shah
de7332ba07 docs: vendor OpenAPI spec locally to fix deploy validation
The hosted spec at api.supermemory.ai/v3/openapi fails Mintlify's OpenAPI
validation: PATCH /brain/models 200 response is missing the required
'description' field, which aborted the whole docs deploy. Vendor the spec
into the repo with the missing description patched, and point both the api
config and the API Reference tab at the local file so deploys no longer
depend on fetching (or the validity of) the live endpoint.

Root-cause fix still needed API-side: add the description to the
/brain/models PATCH route's 200 response in the OpenAPI generator.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:19:14 -07:00
Dhravya Shah
55e96f1db8 docs: correct SDK usage against published packages (TS 4.24.12, Python 3.50.0)
The monorepo's installed supermemory@3.10.0 lags npm. In the published SDKs
client.memories.add does not exist — adding is client.add() (top-level) or
client.documents.add(); client.memories has only forget/updateMemory. Swept
all 21 affected pages. Also: searchMode ('memories'|'hybrid'|'documents')
IS in the published typings and is now taught on hybrid-search as the mode
selector, with include.chunks marked deprecated back-compat; customId
charset corrected (dots, not colons); 14 CONFIRM markers resolved by the
published typings (entityContext, forget reason, Python signatures).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:13:38 -07:00
Dhravya Shah
56666a663f docs: nav restructure — the pitch is the structure
Developer Platform now reads: Start Here -> The Context Engine (concepts-
first: architecture, graph, hybrid search, profiles, permissioning,
surfaces) -> Using supermemory (+ versioning, errors-and-limits) ->
Building on supermemory (patterns) -> Connectors (+ faq, sync-lifecycle)
-> Ops and trust (analytics rejoins nav) -> Self-Hosting (+ tiers,
troubleshooting) -> Migration. container-tags/filtering fold into
permissioning/hybrid-search with redirects; 39 leftover files already
shadowed by redirects removed; every removed path redirects to its next
best page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 15:54:40 -07:00
Dhravya Shah
22f264ad49 docs: phase 0 hygiene — remove 33 orphaned pages with redirects
Every removed page gets a redirect to its next best live page. Salvage-kept:
analytics (only rate-limit/retention docs), integrations/cartesia (only
Cartesia SDK docs), memorybench/supported-models (now added to nav — live
pages link to it). Also removes stray test.py/test.ts/install.md from the
published docs directory.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 15:16:20 -07:00
Dhravya Shah
5567e82377
docs(self-hosting): configurable embeddings for Supermemory local (#1210)
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2026-07-10 19:15:46 -07:00
sohamd22
7d1428e797 docs update for profile buckets and inferred memory review (#1158)
### TL;DR

Adds documentation for the Memory Review endpoints and Profile Buckets feature.

### What changed?

**Memory Review (`memory-review.mdx`)**
- Added a new documentation page covering the two inferred memory review endpoints: `GET /v3/container-tags/{containerTag}/inferred` and `POST /v3/container-tags/{containerTag}/inferred/{memoryId}/review`.
- Documents the three review actions (`approve`, `decline`, `undo`) and how each affects search ranking and memory state (`isInference`, `isForgotten`, `reviewStatus`).
- Includes request/response examples in both `fetch` and cURL, a field reference table, error codes, and a collapsible React Query hooks example for building a review UI.
- Registered the new page in `docs.json` under the "Manage Content" group and linked to it from the Memory Operations next steps.

**Profile Buckets (`user-profiles.mdx`)**
- Added a "Profile Buckets" section explaining custom topical categories (`preferences`, `goals`, `work`, etc.) as a complement to `static`/`dynamic` profile sections.
- Documents the `include`, `buckets`, and `filters` query parameters on the profile endpoint.
- Covers the `GET /v4/profile/buckets` endpoint for listing configured bucket definitions, with request/response examples and a field reference.
- Explains the `[Recent]` / `[Summary]` label convention used in bucket and dynamic profile entries.
- Updated the `ProfileResponse` TypeScript interface to mark `static` and `dynamic` as optional and add the `buckets` field.

### How to test?

- Navigate to the docs site and confirm "Memory Review" appears in the sidebar under "Manage Content".
- Verify all code examples render correctly and tabs switch between `fetch` and cURL variants.
- Confirm the React Query accordion expands and displays the TypeScript snippet.
- Check that the Profile Buckets section renders inline within the User Profiles page, including the response JSON blocks and the tip/note callouts.

### Why make this change?

Inferred (derived) graph memories are down-weighted in search until reviewed, but there was no documentation explaining how to surface or act on them. Similarly, profile buckets were a shipped feature with no public-facing docs. These additions give developers the reference material needed to build review UIs and use topical bucket filtering in their integrations.
2026-06-29 17:23:21 +00:00
ishaanxgupta
4ce13cd4cf Add plugin changelog page (#1160)
## Summary
- Add a dedicated plugin changelog page under the Changelog tab, with recent updates tagged by plugin.
2026-06-25 17:06:59 +00:00
Mahesh Sanikommu
94a1e30742
docs: add Container Tags concept page (#1098) 2026-06-11 16:11:09 -07:00
Dhravya Shah
72bcf88728
docs: self-hosting section for supermemory-server (#1083)
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: Supermemory code review <41898282+Supermemory code review@users.noreply.github.com>
Co-authored-by: Dhravya Shah <undefined@users.noreply.github.com>
2026-06-10 09:41:52 -07:00
sreedharsreeram
14b33401e1 granola docs (#1042) 2026-06-03 20:36:06 +00:00
Dhravya Shah
d0f6a495a6
docs: add codex-supermemory integration page (#885)
Co-authored-by: Vorflux AI <noreply@vorflux.com>
Co-authored-by: MaheshtheDev <38828053+MaheshtheDev@users.noreply.github.com>
2026-05-16 21:41:36 -07:00
Sreeram
b9f3bcad93
convex integration with supermemory (#880)
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-05-11 10:59:14 -07:00
Prasanna
c01e3a3de0
docs: SMFS documentation — providers, Python bash tool, examples (#889)
Co-authored-by: Dhravya <63950637+Dhravya@users.noreply.github.com>
Co-authored-by: docs <docs@supermemory.ai>
2026-04-28 20:04:15 -07:00
MaheshtheDev
0d2ca1bb41 docs: @supermemory/tools v2.0.0 & migration guide (#886)
Some checks failed
Publish Tools / publish (push) Has been cancelled
- Published the v2.0.0 docs and a 1.4 → 2.0 migration guide so existing users have a clear upgrade path.
- Updated the four integration pages (AI SDK, OpenAI, Mastra, VoltAgent) to reflect v2 defaults and link to the migration guide.
- Added a short explainer on the two required fields (containerTag, customId) so new users aren't blocked at first integration.
2026-04-27 18:24:59 +00:00
sreedharsreeram
0783594b8d voltagent-sdk (#791) 2026-04-14 20:22:46 +00:00
MaheshtheDev
bc7f6fcf74 feat: mcp modal with better instructions (#836)
feat: mcp modal with better instructions

add docs screenshots and claude setup
2026-04-08 19:20:11 +00:00
MaheshtheDev
ca3d5d4921 docs: hermes agent instructions (#833) 2026-04-07 22:00:58 +00:00
vorflux[bot]
fc94dd8308
Add MemScore documentation to memorybench docs (#797)
Co-authored-by: Vorflux AI <noreply@vorflux.com>
2026-03-23 15:19:40 -07:00
Dhravya Shah
4033087232 docs: backfill full changelog with Mintlify Update components and tag filtering
Single-page changelog covering Feb 2024 through Mar 2026 with filterable
tags (API, SDK, Console, MCP, CLI, Integrations). Replaces the split
overview/developer-platform pages. Adds redirect for old URL.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-19 12:02:11 -07:00
Dhravya
984297b62d
Add Supermemory integration for Microsoft Agent Framework (#775)
## Summary

This PR introduces comprehensive Supermemory integration for the Microsoft Agent Framework, providing three complementary approaches to add persistent memory capabilities to agents: middleware for automatic memory injection, context providers for session-based memory management, and tools for explicit memory operations.

## Key Changes

- **SupermemoryChatMiddleware**: Automatic memory injection middleware that fetches relevant memories from Supermemory before LLM calls and optionally saves conversations. Supports three modes:
  - `"profile"`: Injects all static and dynamic profile memories
  - `"query"`: Searches for memories relevant to the current user message
  - `"full"`: Combines both profile and query modes

- **SupermemoryContextProvider**: Idiomatic context provider following the Agent Framework pattern (similar to built-in Mem0 integration). Integrates with the session pipeline via `before_run()` and `after_run()` hooks for automatic memory retrieval and storage.

- **SupermemoryTools**: FunctionTool-compatible tools that agents can use for explicit memory operations:
  - `search_memories()`: Search for specific memories
  - `add_memory()`: Add new memories
  - `get_profile()`: Retrieve user profile

- **Utility Functions**: Helper functions for:
  - Memory deduplication across static, dynamic, and search result sources
  - Profile-to-markdown conversion for LLM consumption
  - Message extraction and conversation formatting
  - Logging with configurable verbosity

- **Exception Hierarchy**: Custom exceptions for better error handling:
  - `SupermemoryConfigurationError`: Missing/invalid configuration
  - `SupermemoryAPIError`: API request failures
  - `SupermemoryNetworkError`: Network connectivity issues
  - `SupermemoryMemoryOperationError`: Memory operation failures

- **Comprehensive Documentation**: README with quick start examples, configuration options, and API reference for all three integration approaches.

- **Test Suite**: Unit tests covering middleware, context provider, tools, and utility functions with proper mocking and error scenarios.

## Implementation Details

- Supports both async (aiohttp) and sync (requests) HTTP clients with automatic fallback
- Handles multiple message formats (dict, objects with attributes, content arrays)
- Configurable memory storage with optional conversation grouping via `conversation_id`
- Environment variable fallback for API key configuration (`SUPERMEMORY_API_KEY`)
- Background task management for non-blocking memory operations in middleware
- Proper async/sync compatibility for the Supermemory SDK

https://claude.ai/code/session_012idB5y6UGK3zmeFULgTc4z
2026-03-10 01:49:45 +00:00
Viasocket Interns
48845bb072
feat: adding viaSocket integration page (#757)
Co-authored-by: vishalparmarr <vishalbusiness3108@gmail.com>
2026-03-02 11:37:42 -08:00
Dhravya Shah
bf82efe2bf
docs: add authentication page (#727)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-06 22:12:46 -07:00
Prasanna721
9a0f366ff6 docs: add entity context documentation and fix MDX parsing (#723)
Add entity context documentation to customization and add-memories pages, remove nav icons from Developer Platform, fix install.md parsing error

 Changes:
  - Remove icons from Developer Platform subheadings (Getting Started, Concepts, Using supermemory, Connectors and sync, Migration Guides)
  - Add Entity Context section to customization page with usage example and accordion for advanced API
  - Add entityContext parameter to add-memories Parameters table and examples accordion
  - Fix MDX parsing error in install.md (wrap curly braces in backticks)
2026-02-03 22:53:21 +00:00
nexxeln
16da766fde langgraph integration (#719) 2026-02-03 01:00:59 +00:00
nexxeln
60d6192f5d docs: add OpenAI Agents SDK (#721)
Add documentation for using Supermemory with OpenAI Agents SDK
and CrewAI. Both pages cover user profiles, memory storage,
search, and include practical examples.
2026-02-03 00:51:55 +00:00
Shoubhit Dash
eb0cc9d9d3
docs: add CrewAI integration page (#720)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Dhravya Shah <dhravyashah@gmail.com>
2026-02-02 17:50:35 -07:00
nexxeln
0bf8adb9a6 docs: add Agno integration page (#722) 2026-02-03 00:45:46 +00:00
nexxeln
9553434c9a mastra integration (#717)
adds withSupermemory wrapper and input/output processors for
mastra agents:

- input processor fetches and injects memories into system prompt
before llm calls
- output processor saves conversations to supermemory after
responses
- supports profile, query, and full memory search modes
- includes custom prompt templates and requestcontext support

const agent = new Agent(withSupermemory(
{ id: "my-assistant", model: openai("gpt-4o"), instructions:
"..." },
"user-123",
{ mode: "full", addMemory: "always", threadId: "conv-456" }
))

includes docs as well

this pr also reworks how the tools package works into shared modules
2026-02-03 00:43:08 +00:00
nexxeln
b7e6eb65b9 langchain integration (#718)
adds documentation for using supermemory alongside langchain. no new package
2026-01-31 04:08:10 +00:00
Dhravya Shah
e7642ffc86 fix: docs 2026-01-30 17:32:02 -07:00
Prasanna721
a2a0a266eb docs: add Claude Code integration page (#716)
### update Claude Code docs in integration page

 - Add apps/docs/integrations/claude-code.mdx — documentation for Claude Code Supermemory plugin
  - Add apps/docs/images/claude-code-icon.svg — custom sidebar icon
  - Add apps/docs/images/claude-code-supermemory.png — hero image
  - Update apps/docs/docs.json — add claude-code to Plugins navigation group

### validation
<img width="3046" height="1536" alt="Screenshot 2026-01-29 at 12 50 06 PM" src="https://github.com/user-attachments/assets/5180f237-f886-47a5-a0b3-7436cebd610a" />
2026-01-29 21:02:38 +00:00
Prasanna721
efd6c133e6 docs: add ClawdBot integration page (#714)
Clawdbot docs

Changes:
  - Added integrations/clawdbot.mdx — ClawdBot Supermemory Plugin documentation page with shrimp icon
  - Added "Plugins" group to the bottom of the Integrations sidebar in docs.json
  - Page covers: API key setup (zsh/bash/PowerShell), plugin install, how it works (auto-recall/auto-capture), features (AI
  tools, slash commands, CLI), manual configuration, and advanced options
2026-01-27 22:18:18 +00:00
MaheshtheDev
0d82ac3238 docs: gmail connector (#690) 2026-01-22 07:52:15 +00:00
Dhravya Shah
87b361c26b
docs changes (#678)
Some checks failed
Publish AI SDK / publish (push) Has been cancelled
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-18 16:55:32 -08:00
Prasanna721
ced23c7ea2 pipecat-sdk (#669)
### Changes

 - New documentation page: apps/docs/voice-realtime/pipecat.mdx
  - Installation guide for supermemory-pipecat package
  - Configuration with SupermemoryPipecatService and InputParams
  - Pipeline integration guide
  - How it works (Memory Retrieval, Context Enhancement)
  - Memory modes table (profile, query, full)
  - Configuration options with InputParams
  - Complete FastAPI voice agent example
 - Updated docs.json:
  - Added new "Voice & Realtime" group under SDKs tab with mic icon
  - Removed external npm/pypi link pages from SDK sidebar

### Files Changed

 apps/docs/voice-realtime/pipecat.mdx  (new)
 apps/docs/docs.json                   (modified)

### Navigation

SDKs → Voice & Realtime → Pipecat

#
2026-01-13 05:44:44 +00:00
nexxeln
4850856920 docs: add S3 connector documentation (#657)
Add comprehensive documentation for the S3 connector including:
- Quick setup with TypeScript, Python, and cURL examples
- S3-compatible services support (MinIO, DigitalOcean Spaces, R2)
- Prefix filtering and dynamic container tag extraction
- Connection management and sync behavior
- IAM permissions and security best practices
2026-01-09 03:13:13 +00:00
MaheshtheDev
bc8a739a03 fix: mcp docs navigation link (#656) 2026-01-07 03:39:42 +00:00
Dhravya Shah
bc02650451 add vibe coding instructions for setup 2026-01-03 18:20:47 -08:00
MaheshtheDev
0e3ea4eed2 docs: update with MCP 4.0 setup and instructions (#641) 2026-01-02 21:20:36 +00:00
Dhravya Shah
77f52df0f8 fix: small changes 2025-12-24 11:02:18 -08:00
Prasanna
7e79e227d3
docs: added MemoryBench documentation (#630) 2025-12-24 11:01:26 -08:00
MaheshtheDev
b8e98c7dba add(docs): migration guide from zep to supermemory (#612)
Some checks failed
Publish AI SDK / publish (push) Has been cancelled
add docs for Migration Guide from zep to supermemory
2025-12-20 00:47:52 +00:00
Dhravya Shah
ff35a6bffc fix: change support email to the one on slack 2025-12-18 17:50:37 -08:00
MaheshtheDev
1028c33e58 add(docs): connections configure, fetch resources (#611) 2025-12-07 19:02:52 +00:00
MaheshtheDev
89d056e6ba Update X social links from supermemoryai to supermemory (#607)
we recently got new x/twitter handle and update the references for the links
2025-12-07 03:44:11 +00:00
nexxeln
16979f8bee github connector docs (#594) 2025-12-04 19:00:39 +00:00