Skip to content

madeinoz67/madeinoz-recordmanager-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

27 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

name Records Manager Skill
pack-id madeinoz-recordmanager-skill-v2.0.0
version 2.0.0
author madeinoz67
description Expert record keeping system with paperless-ngx integration, hierarchical taxonomies, and intelligent document management
type skill
purpose-type
productivity
automation
organization
platform agnostic
dependencies
keywords
records
management
paperless-ngx
documents
hierarchical-taxonomy
archiving
household
corporate
compliance

Records Manager Skill

Records Manager Skill

Documentation

Expert record keeping system with hierarchical taxonomies, paperless-ngx integration, country-specific compliance, and intelligent document management

Quick Start

# Clone to PAI skills directory
git clone https://github.com/madeinoz67/madeinoz-recordmanager-skill.git ~/.claude/skills/RecordsManager

# Configure environment
export MADEINOZ_RECORDMANAGER_PAPERLESS_URL="https://your-paperless-url.com"
export MADEINOZ_RECORDMANAGER_PAPERLESS_API_TOKEN="your-api-token"
export MADEINOZ_RECORDMANAGER_COUNTRY="Australia"
export MADEINOZ_RECORDMANAGER_DEFAULT_DOMAIN="household"

# Verify installation
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts --help

Features

  • 🌳 Hierarchical Taxonomies (NEW v2.0) - Navigate documents through a 4-level structure: Function β†’ Service β†’ Activity β†’ DocumentType
  • πŸ” Intelligent Classification - Autocomplete, fuzzy matching, and keyword search for precise document categorization
  • βš–οΈ Country-Specific Compliance - Record keeping guidelines for Australia, US, and UK with legal citations
  • πŸ›‘οΈ Safe Operations - Deletion confirmation workflow prevents catastrophic data loss
  • πŸ“Š Smart Organization - Automatic tagging, hierarchical storage paths, and retention tracking
  • πŸ€– Specialized Agents - Records Keeper, Compliance Guardian, Archive Architect, Deletion Auditor, Sensitivity Scanner, and Retention Monitor
  • πŸ”„ Migration Support - Seamless migration from flat to hierarchical taxonomies with 90%+ automatic mapping

How It Works

The Records Manager Skill uses a three-layer architecture:

  1. Intent Layer - Detects record keeping intent and routes to workflows
  2. Expertise Layer - Provides domain-specific knowledge (taxonomies, compliance, trust management)
  3. Execution Layer - Performs operations via CLI and paperless-ngx API

Core principle: Organize once, find forever. Your AI assistant becomes an expert records manager that knows how to properly categorize, tag, and manage documents according to best practices and local requirements.

Example Usage

Hierarchical Classification (v2.0)

# Upload with hierarchical path
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts upload \
  --file ~/Downloads/medical-receipt.pdf \
  --domain household \
  --path "HealthManagement/MedicalCare/Consultations/MedicalReceipt"

# Autocomplete partial paths
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts taxonomy autocomplete \
  --domain household \
  --path "health/med/cons"

# Search by keywords
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts taxonomy search \
  --domain household \
  --keywords "dental invoice"

# Navigate hierarchy interactively
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts taxonomy functions --domain household
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts taxonomy services --domain household --function HealthManagement

Traditional Operations

# Search for documents
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts search \
  --tags "Function:HealthManagement,DocumentType:MedicalReceipt" \
  --domain household

# Check retention status
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts retention \
  --domain household \
  --path "HealthManagement/MedicalCare/Consultations/MedicalReceipt"

Deletion Safety: All deletions require explicit confirmation through the Deletion Auditor agent - cannot be bypassed.

What's New in v2.0: Hierarchical taxonomies provide 4-level classification (Function β†’ Service β†’ Activity β†’ DocumentType) with autocomplete, fuzzy matching, and automatic tag generation. See Hierarchical Taxonomies Guide for details.

Taxonomy Management

Keep your paperless-ngx instance synchronized with the latest taxonomy definitions:

# Check for available updates (read-only, safe to run anytime)
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts check-updates \
  --country Australia

# Apply updates WITHOUT retention changes
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts sync-taxonomies \
  --country Australia

# Apply updates WITH retention changes (requires explicit approval)
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts sync-taxonomies \
  --country Australia \
  --approve-retention-changes

# View taxonomy version history
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts diff-taxonomies

Why This Matters:

  • Compliance Safety - Retention changes require explicit approval to prevent accidental compliance violations
  • Atomic Updates - All changes rollback on failure (no partial state)
  • Audit Trail - All changes logged to $PAI_HOME/MEMORY/RECORDSMANAGER/
  • Single Source of Truth - All taxonomies come from src/skills/RecordsManager/Config/taxonomies.yaml

CRITICAL: Never bypass these commands by:

  • ❌ Making direct API calls to create tags/document types
  • ❌ Manually adding taxonomies through paperless-ngx UI
  • ❌ Writing custom scripts that bypass the CLI
  • ❌ Using TaxonomyInstaller methods directly without CLI wrapper

See Taxonomy Update Workflow for complete documentation.

Documentation

πŸ“– Full Documentation

Getting Started

User Guides

Reference

Tutorials

For AI Assistants πŸ€–

If you are an AI coding assistant (Claude, Cursor, Copilot, etc.), read INSTALL.md before attempting installation.

The INSTALL.md file contains:

  • Prerequisites and dependencies
  • Pre-installation system analysis
  • Step-by-step installation workflow
  • Environment variable configuration
  • Verification and testing procedures
  • Troubleshooting common issues

Configuration

Environment Variables (required):

# Paperless-ngx connection
export MADEINOZ_RECORDMANAGER_PAPERLESS_URL="https://your-paperless-url.com"
export MADEINOZ_RECORDMANAGER_PAPERLESS_API_TOKEN="your-api-token"

# Records Manager settings
export MADEINOZ_RECORDMANAGER_COUNTRY="Australia"  # Australia | US | UK
export MADEINOZ_RECORDMANAGER_DEFAULT_DOMAIN="household"  # household | corporate | unit-trust | discretionary-trust | family-trust | project

See Environment Variables Reference for complete configuration options.

What's Included

Component File Purpose
Skill definition src/skills/RecordsManager/SKILL.md Main skill routing and workflow definitions
Paperless API client src/lib/PaperlessClient.ts Complete paperless-ngx API integration
Taxonomy expert src/lib/TaxonomyExpert.ts Country-specific record keeping taxonomies
Trust expert src/lib/TrustExpert.ts Trust document management (FTE, deeds)
Record manager CLI src/skills/RecordsManager/Tools/RecordManager.ts Main CLI tool for all record operations
Delete confirmation src/workflows/DeleteConfirmation.md Mandatory workflow for deletion approval
Test suite src/tests/RecordManager.test.ts Comprehensive test coverage

Summary:

  • Files: 7 core components
  • Skills: 1 registered skill
  • Dependencies: None (uses bun runtime)
  • External services: paperless-ngx instance required

Design Principles

  1. Safety First - Deletion requires explicit approval through Deletion Auditor
  2. Taxonomy-Driven - Structure emerges from domain expertise, not ad-hoc decisions
  3. Country-Aware - Record keeping rules vary by jurisdiction
  4. Search-Optimized - Structures designed for finding, not just storing
  5. Complete - Every component from API client to confirmation workflow included

Contributing

Contributions are welcome! See CONTRIBUTING.md for:

  • Code contribution guidelines
  • Documentation development workflow
  • Testing and pull request process
  • Local preview setup (mkdocs serve)

License

MIT License - see LICENSE for details

Changelog

See CHANGELOG.md or Changelog Documentation for version history.

Latest Release: v2.0.0 (2026-01-22)

Major Features:

  • 🌳 Hierarchical Taxonomy System - 4-level classification: Function β†’ Service β†’ Activity β†’ DocumentType
  • πŸ” Smart Classification - Autocomplete, fuzzy matching, and keyword search
  • πŸ“Š Automatic Tag Generation - Hierarchical tags and filesystem-safe storage paths
  • πŸ”„ Migration Support - 90%+ automatic mapping from flat to hierarchical taxonomies
  • βš–οΈ Enhanced Retention - Full hierarchical context for retention requirements

Documentation:

  • Comprehensive API reference for TaxonomyExpert (31 methods)
  • Developer quickstart guide (10-minute setup)
  • Migration guide for existing installations
  • Contributing guide for new taxonomies
  • Troubleshooting section for hierarchical taxonomies

Breaking Changes:

  • Country codes normalized to ISO 3166-1 alpha-3 (AUβ†’AUS, USβ†’USA, UKβ†’GBR)
  • Hierarchical taxonomy is now the default mode
  • Flat taxonomy methods deprecated (12-month transition period)

See Migration Guide for upgrade instructions.


Links: