mem0ai/mem0

mem0-integrate

Integrate Mem0 into an existing repository using a goal-driven, TDD pipeline.

Voir la source

Voir en action

Exemple d’utilisation

Mem0 integration: interactive and bounded repair modes

Author invocation reference for adding Mem0 to an existing Python or Node backend. Requires a clean repository and Platform key or configured OSS setup. The workflow reviews the target surface, goal and plan, writes failing tests and adds a feature flag; the modes below are alternatives, not a sequential script.

Exemple d’entrée

/mem0-integrate                            # interactive, heal ON
/mem0-integrate --no-heal                  # stop after commit; manual verify
/mem0-integrate --heal-max 5               # cap heal attempts per category (default 3)
/mem0-integrate --product platform         # skip the product ask
/mem0-integrate --product oss
/mem0-integrate --ci                       # non-interactive (for test harness)
Licence

Original source text retained; four-space Markdown code indentation normalized only for copyability where applicable. Full source license retained. Author recipes, placeholders and illustrative scorecard are not independently reproduced site results. No source instructions, provider requests, integration, installation, account creation, branch workflow or upstream subagents were executed.

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but not
      limited to compiled object code, generated documentation, and
      conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work.

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to the Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by the Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding any notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   Copyright 2024 Mem0.ai

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/mem0ai/mem0 --skill mem0-integrate

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

mem0-integrate

Wire Mem0 into an existing repo with a goal-driven, test-first pipeline. Pairs with mem0-test-integration for verification.

Canonical sources (fetch before deciding anything)

The skill MUST WebFetch these URLs before step 3 and cite them in plan.md. They are the ground truth — do not rely on ambient knowledge of the Mem0 API.

Agent-ready docs

  • Scope-tagged docs index: https://docs.mem0.ai/llms.txt
  • Full docs (single file, deep dives): https://docs.mem0.ai/llms-full.txt
  • OpenAPI spec (Platform REST, machine-readable): https://docs.mem0.ai/openapi.json
  • Hosted MCP server: https://mcp.mem0.ai/mcp (requires Platform API key)
  • Integrations index: https://docs.mem0.ai/integrations

Published Mem0 skills — delegate; do not reimplement

Prefer these over writing your own call-site patterns. Each is a standalone SKILL.md with triggers, examples, and version-pinned code.

  • SDK (Python + TS, Platform + OSS): https://raw.githubusercontent.com/mem0ai/mem0/main/skills/mem0/SKILL.md
  • CLI: https://raw.githubusercontent.com/mem0ai/mem0/main/skills/mem0-cli/SKILL.md
  • Vercel AI SDK: https://raw.githubusercontent.com/mem0ai/mem0/main/skills/mem0-vercel-ai-sdk/SKILL.md
  • Portable editor/MCP plugin: https://github.com/mem0ai/mem0/tree/main/integrations/mem0-agent-plugin

SDK source (read when docs are ambiguous)

Public repo. Cross-check against the mem0_tested_versions range in this skill's frontmatter if the main branch has moved past a major.

  • Repo root: https://github.com/mem0ai/mem0
  • Python SDK: https://github.com/mem0ai/mem0/tree/main/mem0
  • TypeScript SDK: https://github.com/mem0ai/mem0/tree/main/mem0-ts

Quickstarts (for bootstrapping unfamiliar stacks)

  • Platform: https://docs.mem0.ai/platform/quickstart
  • OSS Python: https://docs.mem0.ai/open-source/python-quickstart
  • OSS Node: https://docs.mem0.ai/open-source/node-quickstart
  • Platform vs OSS comparison: https://docs.mem0.ai/platform/platform-vs-oss

Integration principles (non-negotiable)

The true goal of this skill is to produce a PR the maintainers can accept without argument. That rules out anything invasive.

  1. Additive, not replacing. If the target repo already has a memory

system, a session store, a user-context layer, or anything named Memory / memory_*, Mem0 sits alongside it, not in place of it. The existing system keeps working unchanged.

  1. Opt-in by default. Gate all new Mem0 code behind a feature flag

(env var like MEM0_ENABLED=1, a config key, or a strategy selector). With the flag unset, behavior is the repo's original behavior, byte-for-byte.

  1. No breakage. No removed exports, no renamed public functions,

no changed method signatures, no modified existing tests, no changed behavior of existing tests. All pre-existing tests must pass unchanged both with the flag set and unset.

  1. Minimal dependency surface. Add mem0ai (plus any deps the

delegated skill requires) and nothing else. No new vector stores, no graph databases, no provider SDKs the repo does not already use.

  1. Separable commits. Code, tests, and config/docs land in separate

commits so reviewers can cherry-pick.

  1. The null hypothesis wins. If no additive, gated fit exists after

step 6 (plan), exit with code 1 and a rationale. A bad PR is worse than no PR.

  1. Backend only. Mem0 integration lives in server-side code. API keys,

memory scope, and user-identity resolution are not safe client-side. If the repo has both backend and frontend, the call sites live in backend files. Frontend-only repos are rejected at preconditions.

Enforced at four gates: preconditions (reject frontend-only repos and repos where additive fit is impossible), step 2 comprehension (confirm a backend exists and name candidate surfaces), step 6 plan review (reject plans that mutate existing exports or name client-side call sites), and step 10 self-healing loop (refuse to "fix" principle violations — surface them instead).

Skill delegation rules

Before writing any code, check whether a published skill already covers the target stack. If yes, delegate — copy its call-site pattern into plan.md and into the tests; do not paraphrase.

Detected in target repoDelegate toWhy
@ai-sdk/* + ai in package.jsonskills/mem0-vercel-ai-sdkIntegration is via createMem0 provider wrapper, not raw MemoryClient.
CLI-only repo (Typer, Commander, Click, Cobra) with no LLM call sitesskills/mem0-cliCall sites are command handlers, not model wrappers. Consider whether mem0 actually fits first.
Target is an MCP client / editor config (Claude Code, Cursor, Codex settings)integrations/mem0-agent-pluginLocal stdio MCP server (one search tool) plus skills, no hooks or automatic capture; for a hosted endpoint use https://mcp.mem0.ai/mcp. No SDK code usually needed.
Any other Python or TS repo with an LLM call siteskills/mem0Default SDK integration path.

Record the delegated skill's raw URL in plan.md under a "Delegated skill:" field. The test writer in step 7 and the implementation subagent in step 8 both read this field.

Preconditions

Refuse to start unless ALL of the following are true:

  • Current working directory is inside a git repository with a clean index

(no uncommitted changes). Protects the user's work — every edit lands on a feature branch, not on top of in-progress changes.

  • Repo has a detectable language (package.json / pyproject.toml /

requirements.txt). No language → exit cleanly with a written rationale.

  • Repo has a backend. Detected by: a backend/ or server/ or api/

directory; a Python package with FastAPI/Flask/Django/Starlette; a Node package with Express/Fastify/Koa/NestJS/Next-API-routes; an agent-loop framework (LangGraph, LangChain, LlamaIndex, Agno). Frontend-only repos (pure React/Vue/Svelte SPAs, static sites, mobile-only) → exit with code 1 and a rationale. Mem0 is not installed client-side.

  • The user has already decided Mem0 fits this repo. This skill does NOT

survey the codebase to justify fit — bring a concrete goal. (Step 2 does read the repo to understand what it does and locate backend integration surfaces; that is mechanics, not fit-justification.)

Exit with a written rationale if any precondition fails. Do not try to "make it work anyway."

Pipeline

Ten steps. Full mechanics, document templates, and gate rules are in `references/pipeline.md`. Read that file when you start executing a step; the summary below is only for routing.

#StepGate
1Language detection. package.json / pyproject.toml / requirements.txt. Monorepo, ask which subdirectory.
2Repo comprehension. Budgeted read of README, contributor docs, entry points, top two directory levels. Produces repo-summary.md with ranked backend surfaces.User confirms the summary and picks a surface. No backend surface, exit 1.
3Product selection. Platform vs OSS, recommended from dependency signals, never asked blank.Locked into goal.md, never re-decided.
4API key check. MEM0_API_KEY (Platform) or OPENAI_API_KEY (OSS). Missing on Platform, default to Agent Mode via mem0 init --agent.CI mode with a missing key, exit 2.
5Goal doc. goal.md: what gets stored, when it is retrieved, why, product, delegated skill, out of scope.Hard gate. Explicit approval required. 3 rejections, exit 3.
6Integration plan. Scoped grep for call sites and identity source. plan.md: write/read patterns, scoping, call sites, dependencies, preserved behavior, coexistence, feature flag, sources, E2E recipe.Hard gate. No plausible additive call site or 3 rejections, exit 5.
7Tests first. Failing write and read tests in the repo's native framework, assertion shapes lifted from the canonical signatures. Must be importable with MEM0_API_KEY unset.Tests must fail. If they pass, they are wrong.
8Implementation. Fresh-context subagent, prompt in `references/subagent-prompts.md`, returns a diff reviewed against plan.md and goal.md.3 review loops, then exit 4.
9Commit and handoff. Branch mem0-integrate/<slug>, four separable commits: dependency, module, wiring, tests.--no-heal stops here.
10Self-healing loop. Runs /mem0-test-integration --ci, categorizes the failure, spawns a bounded remediation subagent, reverts on regression.Pre-existing test failure, stop, exit 6. Never "fix" it.

Artifacts (all under .mem0-integration/)

FilePurposeRetention
repo-summary.mdRepo comprehension + candidate backend surfaces (step 2).Keep across runs.
goal.mdApproved intent. Never rewritten after step 6.Keep across runs.
plan.mdApproved mechanics (where, how, call sites, preserved behavior).Keep across runs.
trace.jsonlEvery tool call, decision, and subagent exchange this run.Overwritten per run.
diff.patchThe committed integration as a reviewable patch.Overwritten per run.
heal-trace.mdPer-attempt record of the self-healing loop (step 10).Overwritten per run.
product.json`{"product": "platform"\"oss", "language": "...", "mem0version": "...", "writesite": "file:line", "readsite": "file:line", "featureflag": "MEM0ENABLED", "preferredsite": "<surface index from step 2>"}`, consumed by the verification skill.Overwritten per run.

.mem0-integration/ is added to .gitignore on first run. Nothing is written outside this directory and the repo's source tree.

Modes

ModeTriggerBehavior
Interactive (default)TTY present, MEM0_INTEGRATE_CI unsetAsks for keys, confirms goal doc, shows recommendations.
CIMEM0_INTEGRATE_CI=1Requires keys in env, requires --product, auto-approves goal doc from goal.md if present, fails fast otherwise.

Invocation

/mem0-integrate # interactive, heal ON /mem0-integrate --no-heal # stop after commit; manual verify /mem0-integrate --heal-max 5 # cap heal attempts per category (default 3) /mem0-integrate --product platform # skip the product ask /mem0-integrate --product oss /mem0-integrate --ci # non-interactive (for test harness)

Exit codes

CodeMeaning
0Success. Feature branch committed; verification skill ready to run.
1Precondition failed (dirty repo, no detectable language, etc.).
2Missing env key in CI mode.
3Goal doc rejected 3+ times — integration is not well-specified.
4Subagent review loop did not converge in 3 rounds.
5Integration plan rejected 3+ times, or no plausible additive call site found.
6Self-healing loop did not converge, detected a non-invasiveness violation, or a pre-existing test failed.

Explicitly out of scope

  • Surveying the repo for fit points. Humans decide where Mem0 helps before

invoking this skill.

  • Replacing any existing memory / session / state system. Always additive

and feature-flagged; see "Integration principles."

  • Modifying pre-existing tests, even to "fix" them under self-heal. Tests

that fail after integration with the flag unset are a non-invasiveness violation, not a bug to patch.

  • Deciding Platform vs OSS silently. Always ask with a recommendation.
  • Switching branches, pushing, or opening PRs. Commits locally and stops

(or enters the heal loop, still local).

  • Data migration between stores. Point user at migration/oss-to-platform

docs if they ask.

  • Provider selection beyond the default LLM for OSS. If they need a custom

LLM / embedder / vector store, route to components/* docs and re-run step 4 with the new key.

Tâches connexes

du même dépôt

Autres Skills

Tous les Skills
mem0ai
Communauté

mem0-oss-to-platform

Plan, then execute, a migration of a project from the mem0 open-source / self-hosted SDK (local Memory class) to the mem0 Platform / hosted SDK (MemoryClient). TRIGGER when: the developer wants to move, switch, or migrate mem0 off OSS/self-hosted to the hosted API, e.g. "migrate my mem0 setup to the platform", "switch from self-hosted mem0 to MemoryClient", "use my mem0 API key instead of a local Qdrant", "replace my local vector store + embedder config with the platform", even without the word

installations
0
GitHub Stars
67,8 k
Mis à jour
23 oct.
mem0ai
Communauté

mem0-test-integration

Verify a Mem0 integration produced by /mem0-integrate. Runs in the same workspace on the same branch (loose coupling) — installs dependencies, runs the repo's native test suite, then exercises a real end-to-end smoke flow against the user's API key. Produces a scorecard. TRIGGER when: user has just run /mem0-integrate and says "verify", "test the integration", "run /mem0-test-integration", or when a .mem0-integration/ directory exists and tests have not been run yet on the current branch. DO NOT

installations
0
GitHub Stars
67,8 k
Mis à jour
23 oct.
mem0ai
Communauté

mem0-vercel-ai-sdk

Mem0 provider for Vercel AI SDK (@mem0/vercel-ai-provider). TRIGGER when: user mentions "vercel ai sdk", "@mem0/vercel-ai-provider", "createMem0", "retrieveMemories", "addMemories", "getMemories", "searchMemories", "mem0 vercel", "AI SDK provider", "AI SDK memory", or is using generateText/streamText with mem0. Also triggers for Next.js apps needing memory-augmented AI. DO NOT TRIGGER when: user asks about direct Python/TS SDK calls without Vercel (use mem0 skill), or CLI terminal commands (use

installations
0
GitHub Stars
67,8 k
Mis à jour
23 oct.
mem0ai
Communauté

mem0

Mem0 Platform SDK for adding persistent memory to AI applications. TRIGGER when: user mentions "mem0", "MemoryClient", "memory layer", "remember user preferences", "persistent context", "personalization", or needs to add long-term memory to chatbots, agents, or AI apps. Covers Python SDK (mem0ai), TypeScript SDK (mem0ai), and framework integrations (LangChain, CrewAI, OpenAI Agents SDK, Pipecat, LlamaIndex, AutoGen, LangGraph). Also covers the open-source self-hosted Memory class. This is the DE

installations
1
GitHub Stars
67,5 k
Mis à jour
20 oct.