storagemarkdown

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2026 License: MIT Imports: 2 Imported by: 0

README

Orchestra Storage Markdown Plugin

File-based storage plugin that persists structured metadata and Markdown content to disk.

Install

go get github.com/orchestra-mcp/plugin-storage-markdown

Usage

# Build
go build -o bin/storage-markdown ./cmd/

# Run (started automatically by the orchestrator)
bin/storage-markdown --workspace /path/to/project --orchestrator-addr localhost:9100

Storage Format

Each file uses standard YAML frontmatter for metadata with a Markdown body:

---
id: FEAT-001
priority: high
status: in-progress
---

# Feature Title

Description and content goes here.

The YAML frontmatter block (--- delimiters) stores structured fields. Everything after the closing --- and blank line is the Markdown body.

Supported Operations

Operation Description
StorageRead Read metadata + body from a file path
StorageWrite Write metadata + body with optimistic concurrency (CAS)
StorageDelete Delete a file
StorageList List files by prefix and glob pattern
Package Description
sdk-go Plugin SDK this plugin is built on
orchestrator Central hub that loads this plugin
plugin-tools-features Feature tools that use this storage

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewStorage

func NewStorage(workspace string) plugin.StorageHandler

NewStorage creates the markdown storage handler for the given workspace directory.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL