muscles-documents 0.1.1

Framework-level document ingestion primitives for Muscles

muscles-documents

Framework-level document ingestion and chunking package for the Muscles ecosystem.

Purpose

• Define contracts for documents, chunking, parsing and metadata.
• Provide an initial pipeline for local files + markdown/text content ingestion.
• Expose Muscles actions to drive ingestion/diagnostics through any transport.

Ecosystem Position

muscles-documents is a framework extension for document flows. It owns source loading, parsing, chunking, metadata and sync planning; it does not own AI model calls or protocol routing.

Related repositories:

• muscles - core action contracts, dispatcher, inspect contract and canonical documentation.
• muscles-ai - AI/RAG actions that can consume document contracts.
• muscles-sql - SQL persistence for projects that store document metadata or ingestion state.
• muscles-mcp - MCP projection for document actions when exposed to AI tools.
• muscles-benchmarks - regression coverage for document extension contracts.

Installation

pip install git+https://github.com/butkoden/muscles-documents.git

The canonical ecosystem install matrix lives in muscles/docs/installation.md.

Configured as a standard module package:

modules:
  documents:
    package: muscles_documents
    sources:
      docs:
        type: local
        path: ./docs

Actions

• documents.sources.list
• documents.source.inspect
• documents.load
• documents.parse
• documents.normalize
• documents.chunk
• documents.sync.plan
• documents.sync.request
• documents.inspect
• documents.doctor

Ingestion Toolkit

The package exposes portable contracts for the document preparation flow:

source -> DocumentRef -> DocumentBlob -> ParsedDocument
       -> DocumentSection / DocumentBlock -> DocumentChunk
       -> DocumentSyncPlan / DocumentSyncResult

MVP components:

• local source adapter with stable relative references;
• raw blob loading with checksums;
• text, markdown and HTML parsers;
• safe text normalizer that preserves markdown code fences;
• fixed-size and heading-aware chunkers;
• dry-run sync planner;
• sync request result contract for project executors/jobs;
• safe inspect and doctor diagnostics.

Projects own persistence and integration policy. They may store refs, blobs, parsed documents, chunks and sync state in PostgreSQL, Elasticsearch, MongoDB, Redis, Qdrant or another system, but muscles-documents does not import those clients and does not write to external stores directly.

muscles-ai can consume DocumentChunk objects after a project stores and exposes them through its own data/search ports. This package does not call LLMs, create embeddings, rank search results or own prompt/RAG behavior.

Python API

from muscles_documents.config import SourceConfig
from muscles_documents.runtime import DocumentPipeline

pipeline = DocumentPipeline(
    key="documents",
    sources={
        "docs": SourceConfig(name="docs", type="local", path="./docs"),
    },
)

refs = pipeline.list_refs("docs")
blob = pipeline.load_blob("docs", refs[0].reference)
parsed = pipeline.parse_blob(blob)
normalized = pipeline.normalize(parsed)
chunks = pipeline.chunk(normalized, strategy="heading")
plan = pipeline.sync_plan("docs")

Scope

MVP is read-only: no writes to external systems are performed. Google Drive, PDF/DOCX, URL/HTTP and richer storage adapters are extension points for later package iterations; the current package keeps parser/source contracts stable for those additions.

Telemetry

muscles-documents resolves telemetry through the neutral Muscles TelemetryProvider; it does not import muscles-otel directly.

When a project registers a provider, document actions emit safe spans:

• muscles.documents.source.list
• muscles.documents.load
• muscles.documents.parse
• muscles.documents.normalize
• muscles.documents.chunk
• muscles.documents.sync.plan
• muscles.documents.sync.execute
• muscles.documents.inspect
• muscles.documents.doctor

Allowed attributes include source name/type, MIME, parser and chunker metadata. Raw document text, HTML body, extracted text, file content, source credentials and tokens must not be stored in span attributes.

Examples

Local source smoke

Run a full documents.* action flow on temporary files:

PYTHONPATH=src python examples/run_documents_pipeline.py

Sync plan and request

Build and inspect a sync plan for configured sources:

PYTHONPATH=src python examples/run_documents_sync.py

Both examples:

• initialize package via init_package(app, config);
• use ActionDispatcher for actions;
• demonstrate load, parse, normalize, chunk, sync.plan, sync.request, inspect, and doctor flows;
• show neutral telemetry provider usage without requiring muscles-otel.