Skip to content

Guides

Semvec ships three families of guides. Pick the one that matches what you're trying to do.

Getting started

The basics — install, run a first turn, learn the vocabulary.

Guide What it covers
Installation pip install paths, the [cortex] / [coding] / [api] / [compliance] extras, embedder setup
Quickstart One-page tour of every product surface — core state, token-reduced context, chat proxy, Cortex, Coding, REST API
Concepts & Glossary Phases, memory tiers, anchors, triggers, topic-switch detection, persistence formats
Licensing Community / Pro / Enterprise tiers, JWT signing, error handling
Migrating from pss Renaming notes if you came from the legacy pss package
Embedders SentenceTransformers, OpenAI, ONNX int8 — pick the right model for your workload
Integrations LangChain retriever, DeepAgents middleware, PostgreSQL persistence, Neo4j graph, Mem0 head-to-head
Correcting memories meta_filter=, per-memory provenance, retrieval policy, anti-resonance in standard retrieval
FAQ When to use Semvec vs. mem0 / Letta / LangChain Memory; GPU / offline / patent-status questions

Coding-Agents

Persistent code memory for Claude Code, Cursor, and custom tooling.

Guide What it covers
Coding (overview) The four usage paths — MCP server with Claude Code hooks, MCP server with Cursor rule, in-process CodingEngine, REST API — and when to pick which
Claude Code Full .claude/settings.json setup with mcpServers and automatic SessionStart / PreCompact lifecycle hooks; CLAUDE.md project rule; tool reference; troubleshooting; end-to-end example session
Cursor .cursor/mcp.json setup; .cursor/rules/semvec.mdc project rule that replaces Claude Code's lifecycle hooks; tool reference; troubleshooting

The MCP server (semvec.coding.mcp_server) and the six pss_* tools are identical across both editors. Claude Code adds the two automatic lifecycle hooks on top — that's the headline integration difference.

Module guides

The major Semvec modules with their full usage paths.

Guide What it covers
Cortex (overview) Multi-agent coordination — three usage paths: in-process SemvecAgentNetwork, SemvecCortexService with a custom store, REST-hosted cluster / region / observer / network stack
Cortex over REST API The full REST-hosted multi-agent stack: cluster, region, global observer (anomaly detection), network (peer transfer, user partitions, trust-score consensus). curl + httpx examples for every endpoint group
Compliance Pack Append-only event store, deterministic replay, GDPR Art. 17 forget with signed deletion certificates, HMAC request signing, RS256 user JWTs. Layer table — what lives in [compliance] vs cron vs [api,compliance]

API reference

Every public class, method, and endpoint:

  • API Reference — table of contents
  • Core (SemvecState) — base state, memory tiers, anchors, triggers, persistence
  • Token reduction — SemvecStateSerializer, SemvecChatProxy
  • Cortex — SemvecAgentNetwork, aggregations, ConsensusEngine, StateVectorPacket
  • Coding — CodingEngine, LiteralCache, MCP server, lifecycle hooks
  • REST API — every endpoint group, auth, error model
  • CLI — semvec serve flags

Comparisons & FAQ