Major release to v1.0.0, aligned with the v1.0.0 framework. The MCP documented the wiring conventions but not the config half of a project, and its example main.go omitted the godotenv autoload — so an assistant starting a service from zero still hand-rolled main.go and the launcher, and got config wrong. This adds a first-class scaffold, completes the config/.env.example conventions, and adds rules that catch the "mess in main" pattern. internal/tools: - New get_scaffold: returns the canonical minimum application scaffold as ready-to-write files (main.go with godotenv autoload + wire.Run(), wire.go, a composed config.go, a health hook, .env.example), with import paths filled from a `module` argument. Registered in tools.go. internal/rules: - Three new validate_snippet rules, appended in scaffold_rules.go: main.dirty (launcher/components built in main instead of internal/wire), main.no-godotenv-autoload (a wire-convention main that never loads .env), and config.raw-getenv (an EINHERJAR_* var read via os.Getenv instead of composing the component Config; EINHERJAR_LOG_* stays with logz.direct-env-read). - scaffold_rules_test.go — internal/rules had no tests; asserts each new rule fires and that a clean main is not flagged. internal/index (builtins): - The synthetic wire module gains a Config section (compose the framework's component configs, load with caarlos0/env, APP_* app fields / EINHERJAR_* framework fields) and a Config & .env.example discipline (every env var the config reads is documented in .env.example, kept in lock-step). - main.go now shows the `_ "github.com/joho/godotenv/autoload"` blank import, previously omitted. The assembly file is renamed launcher.go -> wire.go. - Migrations and seeding removed from the documented scaffold — developer choices, not framework conventions. Re-synced against iron-dough-api / pei-api. Version: - Badge and serverVersion const were stale at v0.1.0; both now v1.0.0. Docs: - README (eleven tools, eleven validation rules) and CHANGELOG updated. No new dependencies. The wire conventions are embedded at build time (//go:embed builtins/README.md) and the new tool and rules are compiled in, so a deployment must be rebuilt to serve them; a server still running the v0.2.0 binary keeps serving the old conventions until redeployed.
9.2 KiB
Changelog — einherjar/mcp
All notable changes to this module are documented here. Format follows Keep a Changelog. This module adheres to Semantic Versioning.
[1.0.0] — 2026-08-07
The MCP reaches v1.0.0, aligned with the v1.0.0 framework. The headline is the
canonical application scaffold: the one opinionated starting point so an AI no longer
hand-rolls main.go and the launcher when creating a service from zero.
Added
get_scaffoldtool. Returns the canonical minimum application scaffold as ready-to-write files, with import paths filled from amoduleargument: a cleanmain.go(godotenv autoload +wire.Run()),internal/wire/wire.go(the launcher assembly), a composedinternal/config/config.go, a health feature hook, and.env.example.- Three
validate_snippetrules (now eleven total), with a rules test suite:main.dirty(the launcher/components built inmaininstead ofinternal/wire),main.no-godotenv-autoload(a wire-conventionmainthat never loads.env), andconfig.raw-getenv(reading a frameworkEINHERJAR_*var viaos.Getenvinstead of composing the component'sConfigtype). - Config conventions in the
wirebuiltin. AConfigsection (compose the framework's component configs, load withcaarlos0/env,APP_*for app-owned fields,EINHERJAR_*for framework ones) and a Config & .env.example section: every env var the config reads must also be documented in.env.example, kept in lock-step.
Changed
wirebuiltin re-synced to the current gold standards (iron-dough-api,pei-api):main.gonow shows the_ "github.com/joho/godotenv/autoload"blank import (previously omitted, so the AI produced amainthat never loaded.env); the assembly file iswire.go(waslauncher.go).- Version alignment. The README badge and
serverVersionwere stale atv0.1.0; both now readv1.0.0.
Removed
- Migrations and seeding from the
wirebuiltin. How migrations run and how the first admin is seeded (via code, a DB team, an endpoint, a webhook, …) is the developer's choice — it belongs to no Einherjar module and is not a hard convention, so it is out of the scaffold and the documented conventions.
[0.2.0] — 2026-06-10
Minor release. The indexer now captures the members of composite types, closing a gap where get_symbol and search_symbols could name a struct or interface but not describe its shape — most painfully, struct tags (env-var keys, json names) were invisible.
Added
- Struct fields in the index. Each struct-type symbol now carries a
fieldsarray — field name, type, raw struct tag (backticks stripped), doc comment, and anembeddedmarker.get_symbolreturns it; previously the signature was truncated to the baretype X structheader, so field names, types, and tags (e.g.env:"EINHERJAR_PG_HOST") were dropped entirely. - Interface method sets in the index. Each interface-type symbol now carries a
methodsarray — method name, signature (without the leadingfunc), and doc comment, including embedded interfaces. Consumers can now see what a port likedb-postgresProvideractually requires. - Search by field/tag/method.
search_symbolsnow also matches a query against struct field names, field types, and struct tags, and against interface method names/signatures — so an env-var key or a method name resolves to the type that declares it. internal/indextest suite covering field, tag, embedded-field, interface-method, and search-by-tag capture (the package previously had no tests).
Notes
- The index schema gains two optional (
omitempty) fields;SchemaVersionis unchanged because the change is additive and older consumers parse the new index unchanged. - This is a pure indexer/schema change. The live server picks it up on its next image build, which re-runs
cmd/indexer(seeDockerfile). A deployment that has not been rebuilt will still serve the older, member-less index.
[0.1.1] — 2026-05-29
Patch release. Two changes to cmd/server make the binary cleaner to run behind a unix socket on a reverse-proxied host, plus two repository-hygiene changes that follow from the same deployment exercise.
Added
- Systemd socket activation in
cmd/server. The binary inherits the listener fromLISTEN_FDSviagithub.com/coreos/go-systemd/v22/activationwhen present, falling back transparently to TCP-addrbinding otherwise. Startup log records"mode":"socket-activated"or"mode":"tcp". Same binary, no flag or env var to toggle.
Changed
- Health probe path moved from
/healthzto<path>/healthz(default/mcp/healthz). Lets a reverse proxy expose the entire MCP service through one location prefix. v0.1.0 consumers hitting the old/healthzroute receive 404; update to/mcp/healthz(or whatever path matches your-pathflag). README.mddeployment section rewritten to be hosting-agnostic. Points at theDockerfileand systemd socket activation as supported binary modes without prescribing one operator's setup. Adds the SSE-buffering caveat once: any reverse proxy must disable response buffering on the/mcplocation, otherwise Server-Sent Events get batched and streamable MCP sessions break./deploy/is now.gitignored. Local deployment artefacts (systemd units, reverse-proxy templates, per-release scripts) are operator-specific by design and live outside the public repository. TheDockerfileat the module root remains the only portable, public-facing build artefact.
Dependencies
- Added:
github.com/coreos/go-systemd/v22 v22.7.0— used bycmd/serverto detect and use a systemd-passed listener.
Upgrade notes
| If you… | Action |
|---|---|
| Consume the MCP service from an MCP client (Claude, Cursor, Zed, etc.) | None — /mcp is unchanged |
| Monitor the service via the healthz probe | Update the probe URL from /healthz to /mcp/healthz |
| Run the binary directly (no reverse proxy) | None — -addr TCP binding still works the same way |
| Run the binary under systemd with a socket unit | The same binary now picks up the inherited listener automatically |
[0.1.0] — 2026-05-29
Initial release. The mcp module hosts the Einherjar Model Context Protocol server — a remote, streamable-HTTP service that teaches AI assistants about every other module of the framework.
Added
Server (cmd/server)
- Streamable-HTTP MCP server built on
github.com/modelcontextprotocol/go-sdkv1.0.0 - Listen address and HTTP path configurable via
EINHERJAR_MCP_ADDR(default:8080) andEINHERJAR_MCP_PATH(default/mcp) /healthzliveness endpoint- Embedded framework index loaded once at startup; in-memory for the lifetime of the process
Indexer (cmd/indexer)
- Walks an Einherjar repository checkout and produces
data/index.json - For each sibling module captures: import path, Go version, README (full + extracted tagline), CHANGELOG, root
doc.gopackage comment, sub-package doc comments, every exported symbol (type/interface/func/method/const/var) with signature + godoc, ADRs, README code-fence examples, dependency edges fromgo.mod, and the contents ofcompliance_test.go(interface assertions + structural test names) - Appends a synthetic
wiremodule documenting canonical Einherjar application wiring conventions
Tools (10)
list_modules— enumerate every Einherjar module with purpose and sub-packagesget_module— package doc, dependencies, sub-packages, key symbols, ADRs, compliance counts; optional embedded READMEsearch_symbols— full-text search across name, doc, sub-package, moduleget_symbol— full signature, doc, and source location for one symbollist_adrs— list architectural decision records, optionally filtered by moduleget_adr— fetch one ADR's markdown bodyget_example— canonical usage snippets extracted from module READMEs and thewireconventionsget_compliance— interface assertions and structural test names from a module'scompliance_test.goget_changelog— full CHANGELOG.md markdown for one modulevalidate_snippet— pattern-match a Go snippet against framework conventions; returns findings with severity, hint, and line
Validation rules (8)
launcher.missing-run,launcher.no-components,launcher.run-error-discardedlogz.direct-env-readweb.server-not-appendedwire.hook-bad-signature,wire.hook-outside-beforestart,wire.route-specific-after-param
Synthetic wire module
- Authored in
internal/index/builtins/README.md; participates inlist_modules,get_module, andget_exampleexactly like a real module - Sections: project layout,
Run()shape, feature hook shape, route ordering, authorization, middleware helpers, adapters at the wire boundary, migrations and seeds - All examples use einherjar import paths
Packaging
- Multi-stage
Dockerfilethat builds from the einherjar repository root (docker build -f mcp/Dockerfile .) so the indexer can walk every sibling module at image-build time - Distroless runtime image; static binary; non-root user