The neo4j-agent-memory Technology Compatibility Kit (TCK) provides a formal specification, executable test suite, and compliance framework for the neo4j-agent-memory ecosystem.
Each language client (TypeScript, Go, C#, R, Python) ships two transports behind a single MemoryClient API: a BridgeTransport for TCK conformance tests and a RestTransport for the hosted Neo4j Agent Memory Service at https://memory.neo4jlabs.com/v1. Selection is automatic — endpoints containing a /v1 segment route through REST.
This documentation follows the Diataxis framework, organized into four sections:
| Section | Purpose |
|---|---|
Step-by-step lessons for getting started |
|
Goal-oriented recipes for specific tasks |
|
Technical descriptions of the machinery |
|
Background and context for understanding the system |
Tutorials
Learning-oriented guides that walk you through a complete task from start to finish.
-
Hosted-Service Quickstart — Five-minute path from zero to a working agent against
memory.neo4jlabs.com/v1, with snippets in TS / Python / Go / C# / R -
Getting Started with the TCK — Install the TCK, write your first adapter, and run the test suite
-
Building Your First TypeScript Agent with Memory — Use
@neo4j-labs/agent-memoryto add memory to a Vercel AI SDK application
How-To Guides
Task-oriented guides for accomplishing specific goals.
-
Authenticate —
nams_*API keys, OAuth refresh-token rotation, and scope management -
Framework Integrations — Vercel AI SDK, LangChain JS, Mastra, LangGraph, PydanticAI, Semantic Kernel, ellmer, MCP
-
Writing a TCK Adapter — Implement
BaseAdapterfor your memory system -
Cross-Language Conformance Testing — Test TypeScript, Go, C#, R, or Python implementations via the HTTP bridge
-
Adding TCK to Your CI Pipeline — Run conformance tests in GitHub Actions
-
Obtaining TCK Certification — Generate compliance reports and submit to the registry
Reference
Technical descriptions of types, protocols, and interfaces.
-
REST API Reference — Hosted-service endpoints mapped to client SDK methods in each language
-
MCP Tool Reference — The 12 standard memory tools matching
memory.neo4jlabs.com/mcp -
BaseAdapter Interface Reference — All abstract methods (Bronze + Silver + Gold + Volume 5 / Platinum) with signatures
-
HTTP Bridge Protocol Specification — Endpoints, request/response schemas, and data types (v0.2.0)
-
Compliance Tier Definitions — Bronze, Silver, Gold, and Platinum requirements
-
Scenario ID Registry Format — Stable scenario ID scheme and registry structure
Explanation
Background concepts and architectural decisions.
-
TCK Architecture and Design Decisions — Why pytest over Gherkin, the adapter pattern, the bridge protocol, and the dual-transport client architecture
-
The Agent Memory Model — Short-term, long-term, and reasoning memory, plus observations, reflections, and provenance
-
Cross-Agent Memory Sharing — How agents in different languages share the same memory graph