agentleFS
maximem-aimaximem-ai/maximem_synap_sdk/AGENTS.md

maximem_synap_sdk

AGENTS.md79 starsChanged 46 days agoApache-2.0View on GitHub

JS parity suites need monorepo-only fixtures and are skipped in this mirror.

  • Installs packages
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository5 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Follow skills/synap/SKILL.md.

    line 28

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

What this repo is

The published mirror of the Maximem Synap Python and JavaScript SDKs, 24 framework integrations, and the MCP server adapter. The Synap memory engine is a hosted service; these packages are clients for it.

Important for contributors and agents

This repository is overwritten by an automated sync from Maximem's private monorepo. Pull requests that change files under packages/ are closed, because the next sync would revert them. Open an issue instead: https://github.com/maximem-ai/maximem_synap_sdk/issues

Build and test

Python SDK (Python 3.11+):

pip install -e "packages/sdks/maximem-synap[dev]" pytest-asyncio
pytest packages/sdks/maximem-synap/tests

JS parity suites need monorepo-only fixtures and are skipped in this mirror.

Layout

  • packages/sdks/ core Python and JavaScript SDKs
  • packages/integrations/ one installable package per agent framework
  • packages/mcps/ MCP server adapter (stateless, over the hosted API)
  • skills/synap/ agent skill for Claude Code
  • skills/synap-codex/ agent skill for Codex
  • packages/sdks/maximem-synap/tests/ Python SDK tests

Adding Synap to a user's project

Follow skills/synap/SKILL.md. It covers setup, scoping (client, customer, user, conversation), ingestion, retrieval, and one wiring guide per framework.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.