Skip to main content

Domain-agnostic vault-governance engine: frontmatter schema profiles, indexing, ranked search, a task ledger, atomic writes, and a composable MCP core (register_core). The reusable core behind severino-vault-mcp and severino-edu-mcp.

Project description

severino-vault-engine

PyPI Python License: MIT

A domain-agnostic vault-governance engine — the reusable core behind severino-vault-mcp and severino-edu-mcp. It governs a Git-backed, frontmatter-tagged Markdown vault (Obsidian-style) and exposes that governance both as a library and as a composable MCP tool surface.

Building your own MCP on this engine? Read AGENTS.md — a drop-in recipe an AI coding agent can follow to stand up a conformant server in minutes.

What's in it

  • SchemaProfile — a vault's frontmatter contract (doc-types, statuses, id-prefixes, the task lifecycle), with as_dict() (HQ/CI contract) and check_doc_enums(). One engine, many profiles: a different vault is a different profile, not a fork.
  • Index + search — a lenient frontmatter index and ranked, section-scoped retrieval (find_sections) that returns menus, never raw bodies.
  • Task ledgerdoc_type: task docs derived from the index, with a validated write path.
  • Atomic writes — a single serializer and atomic_write_text / transactional_replace, so every writer shares one escaping + durability rule.
  • register_core(mcp, ctx) — composes the generic MCP tools (search, doc read with a sensitivity gate, project inventory, daily progress, the task ledger, schema-validated frontmatter writes) onto any FastMCP server.

Install

pip install severino-vault-engine        # or:  uv add severino-vault-engine

The import package is vault_engine; the distribution on PyPI is severino-vault-engine.

Use

from vault_engine.config import Config
from vault_engine.context import ServerContext
from vault_engine.core_tools import register_core
from mcp.server.fastmcp import FastMCP

ctx = ServerContext(Config.from_env())          # your vault + profile
mcp = FastMCP("my-vault-mcp")
register_core(mcp, ctx)                          # + your own tool groups

The servers in the family own only their domain (writeup/topology tools, course tools) and a thin entrypoint; everything generic lives here.

Security

Releases are published to PyPI from GitHub Actions via OIDC Trusted Publishing (no long-lived API tokens) with PEP 740 attestations. To report a vulnerability, see SECURITY.md.

License

MIT © Joe Severino

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

severino_vault_engine-0.1.3.tar.gz (62.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

severino_vault_engine-0.1.3-py3-none-any.whl (65.1 kB view details)

Uploaded Python 3

File details

Details for the file severino_vault_engine-0.1.3.tar.gz.

File metadata

  • Download URL: severino_vault_engine-0.1.3.tar.gz
  • Upload date:
  • Size: 62.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for severino_vault_engine-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3f7a06d9a824a6c4d31cbcf746520310a852275b7e462b4af5fd2b477c3987af
MD5 cf455831ff9163c908c4af63feb657b5
BLAKE2b-256 61cf6db605950a5834be4760149c5ba2b8c0adc2e870de235d3e87113b085795

See more details on using hashes here.

Provenance

The following attestation bundles were made for severino_vault_engine-0.1.3.tar.gz:

Publisher: publish.yml on joeseverino/vault-engine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file severino_vault_engine-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for severino_vault_engine-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 537fec675970700e11827face6cb31d791136d61af5cc49eed97c488e18bdb24
MD5 b195c3ff3c9a74d9ceb12311df8a6662
BLAKE2b-256 c97a2b5aca3b841f021b32925c7d69704a158214171c1dedfc9ed97b004fbe59

See more details on using hashes here.

Provenance

The following attestation bundles were made for severino_vault_engine-0.1.3-py3-none-any.whl:

Publisher: publish.yml on joeseverino/vault-engine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page