Skip to content

mankinskin/memory-api

Repository files navigation

memory-api

memory-api is the repository that exposes the core crates and operator surfaces behind rules, specs, tickets, and audits.

Direct child READMEs:

Installable and executable surfaces in this repository include the rule, spec, ticket, and audit CLIs, the rule-mcp, spec-mcp, ticket-mcp, and audit-mcp MCP servers, and the spec-http and ticket-http HTTP binaries.

Tool Surface

Crate or surface What it is used for Typical entry points
memory-api Generic filesystem-backed entity storage, schema validation, SQLite indexing, search, edge management, and board coordination. Reused by the other crates in this repo.
rule-api Canonical rule manifests, markdown import, target composition, and nested workspace discovery. rule, rule-mcp
spec-api Specification manifests, sections, slugs, code references, and validation rules. spec, spec-mcp, spec-http
ticket-api Ticket domain logic, workspace state, board snapshots, execution contracts, watchers, and reconciliation. ticket, ticket-mcp, ticket-http, ticket-vscode
audit-api Repository quality audits, indexes, summaries, and review-oriented validation flows. audit, audit-mcp

Dependency Graph

flowchart LR
    subgraph Shared
        Memory[memory-api]
        Viewer[viewer-api]
    end

    subgraph Domain
        Rule[rule-api]
        Spec[spec-api]
        Ticket[ticket-api]
        Audit[audit-api]
    end

    subgraph CLI
        RuleCli[rule-cli]
        SpecCli[spec-cli]
        TicketCli[ticket-cli]
        AuditCli[audit-cli]
    end

    subgraph MCP
        RuleMcp[rule-mcp]
        SpecMcp[spec-mcp]
        TicketMcp[ticket-mcp]
        AuditMcp[audit-mcp]
    end

    subgraph HTTP
        SpecHttp[spec-http]
        TicketHttp[ticket-http]
    end

    Rule --> Memory
    Spec --> Memory
    Ticket --> Memory

    RuleCli --> Rule
    RuleCli --> Memory
    SpecCli --> Spec
    SpecCli --> Memory
    TicketCli --> Ticket
    TicketCli --> TicketHttp
    AuditCli --> Audit

    RuleMcp --> Rule
    RuleMcp --> Memory
    SpecMcp --> Spec
    SpecMcp --> Memory
    TicketMcp --> Ticket
    AuditMcp --> Audit

    SpecHttp --> Spec
    SpecHttp --> Memory
    SpecHttp --> Viewer
    TicketHttp --> Ticket
    TicketHttp --> Viewer
Loading

Tool Use Examples

Install the CLI tools

From the context-engine repo root, the shared installer can run the same four Cargo installs for you:

bash ./install-tools.sh --tool rule-cli --tool spec-cli --tool ticket-cli --tool audit-cli

If you are working directly from a memory-viewers/memory-api checkout instead of the repo root, run the underlying install commands from this workspace:

cargo install --path tools/cli/rule-cli --bin rule
cargo install --path tools/cli/spec-cli --bin spec
cargo install --path tools/cli/ticket-cli --bin ticket
cargo install --path tools/cli/audit-cli --bin audit

After that, verify the install with rule --help, spec --help, ticket --help, and audit --help. The command-specific docs live in tools/cli/rule-cli/README.md, tools/cli/spec-cli/README.md, tools/cli/ticket-cli/README.md, and tools/cli/audit-cli/README.md.

Set up a workspace repository

From the repository root, just run the tools. They discover an existing .rule, .spec, or .ticket by walking up from the current directory, and if none exists yet they initialize a local one in the current repository and seed a folder-local .gitignore for generated index files.

rule list
spec list
ticket board show
audit run .

When you add the first rule, spec, or ticket, the canonical rules/, specs/, and tickets/ folders are created automatically inside those local tool roots.

Common repo-local tasks

rule sync-targets --config rule-targets.yaml
spec refs <spec-id> validate
ticket board show
audit run .

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages