A development guide for Synaplan, a full-stack knowledge-management application that stores information, searches it by meaning, and provides chat interfaces. It also covers connections to WhatsApp and email and several AI providers.

Use it when developing or deploying Synaplan, including its PHP and Vue application, Docker environments, vector search, chat widgets, and messaging integrations.

It gives developers project rules and architecture details for working on Synaplan without guessing how its services fit together.

Synaplan — Instructions file for Codex and OpenCode by metadist: A development guide for Synaplan, a full-stack knowledge-management applica

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add instructions/metadist/synaplan/agents-md

Clone the repo

git clone --depth 1 https://github.com/metadist/synaplan

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/metadist/synaplan/agents-md.svg)](https://agentmods.dev/instructions/metadist/synaplan/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/metadist/synaplan/agents-md"><img src="https://agentmods.dev/badge/instructions/metadist/synaplan/agents-md.svg" alt="Measured on agentmods" height="20"></a>

Per session 6,005 This file is loaded in full into every session.

When invoked 6,005 The same file — it is already loaded in full.

Security scan C 2 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.06005	$0.06005
Opus 5	$0.03002	$0.03002
Sonnet 5	$0.01201	$0.01201
Haiku 4.5	$0.00600	$0.00600

Measured 4d ago against content hash 95d9b313b360, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade C, and why

Synaplan scanned grade C with 2 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Recursive force deletehighDestructive command

rm -rf with a variable or a broad path is one typo away from removing the wrong tree.

docker compose exec -T backend sh -c 'rm -rf var/cache/test && mkdir -p var/cache/test && chmod -R 777 var/cache/test'

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- Test endpoints via Swagger UI at `http://localhost:8000/api/doc` (not curl/Postman). Before creating a new endpoint, check if a similar one exists.

AGENTS.md · 352 lines

How it starts

The opening of the file, as written. The whole thing — 352 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Synaplan Development Guide

Full-stack AI knowledge management platform: RAG with MariaDB VECTOR + Qdrant, embeddable chat widgets, WhatsApp/Email integration, multiple AI providers (Ollama, OpenAI, Anthropic, Groq, Gemini, xAI).

Stack: PHP 8.3/Symfony 7, Vue 3/TypeScript/Vite, Docker Compose, frankenphp/caddy.

Repository Architecture

Repo	Purpose
`synaplan/`	Main app source code, local development environment (includes Qdrant)
`synaplan-base-php/`	Base Docker image (FrankenPHP + gRPC + whisper.cpp)
`synaplan-platform/`	Production deployment configs, pulls pre-built images

Local dev (synaplan/): Builds from source, includes all dev tools (phpMyAdmin, MailHog, Vite dev server). Qdrant runs as a Docker service for AI memories and RAG vector search.

Production (synaplan-platform/): Uses ghcr.io/metadist/synaplan:latest, multi-server with external Galera cluster. See _devextras/SYSADMIN-help.md.

Critical Rules

Language

Code, comments, commit messages: ALWAYS English. Never write German (or any other language) in code or comments.
Chat responses: in the language the user chooses.

Docker Environment

All backend/frontend tooling runs inside containers:

docker compose exec backend php bin/console cache:clear
docker compose exec -T frontend npm run check:types

Prefer the make targets (they wrap docker compose exec correctly).

The database is MariaDB, not MySQL — the db container has no mysql binary. Use the mariadb client with the app credentials from docker-compose.yml:

docker compose exec -T db mariadb -usynaplan_user -psynaplan_password synaplan -e "SELECT ..."

Git — allowed, but NEVER on main

Git operations (branch, add, commit, push) are allowed.
NEVER commit or push directly to main; never force-push main or master. All changes go through feature branches + PRs.
Use Conventional Commits: feat:, fix:, refactor:, docs:, chore:, test: — e.g. feat(frontend): add runtime config API support.
NEVER add attribution ("Generated with Claude Code", "Co-Authored-By: …", or similar).

Read the full file on GitHub · 352 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

4d ago First seen · 352 lines · 6,005 tokens per session scan C 95d9b313b360

Subscribe to this mod's changes

Synaplan is an instructions file published in the GitHub repository metadist/synaplan (111 stars, last pushed 4d ago), licensed Apache-2.0. It adds 6,005 tokens to every session, about $0.0300 per session on Opus 5. A static security scan graded it C with 2 findings (recursive force delete, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Data and AI Memory and context RAG and vectors ai chat

Synaplan

Getting it into your agent

Wrote this? Show the measurements

What it costs to keep this loaded

Grade C, and why

Recursive force deletehighDestructive command

Makes network callslowCapability

How it starts

Synaplan Development Guide

Repository Architecture

Critical Rules

Language

Docker Environment

Git — allowed, but NEVER on main

What this file has done since we first saw it

Other instructions, from other repositories

MemOS CLAUDE.md

memsearch CLAUDE.md

MemOS AGENTS.md

rag-rat AGENTS.md

obsidian-notes-rag CLAUDE.md

llm-brain CLAUDE.md