jakob48/crumbs
1
0
Fork 0
forked from mirror/crumbs-original
Code Pull Requests Activity
Files
4d5ea352049311b2a0ff16a84bd5f637955f6453
crumbs/docs/FEATURES.md
T
Frederic CabassutandClaude Opus 4.6 fe88b15a0d docs: add MCP server and API key documentation 
- Update FEATURES.md, ARCHITECTURE.md, DEPLOYMENT.md with MCP sections
- Add MCP endpoints to OpenAPI spec and regenerate API.md
- Add rebase-before-PR best practice to CLAUDE.md git conventions
- Update README with MCP/API feature mention

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-09 02:03:04 +01:00

4.3 KiB
Raw Blame History

Features

Core Features (MVP)

Notes CRUD

  • Create, read, update, and delete notes
  • Notes have a title and content body
  • Content supports full Markdown syntax
  • Auto-save on editor close

Rich Text Editor

  • WYSIWYG editing powered by Tiptap
  • Formatting toolbar with visual controls
  • Raw Markdown mode toggle for direct editing
  • Undo/Redo with keyboard shortcuts

Text Formatting

  • Bold (**text** / Ctrl+B)
  • Italic (*text* / Ctrl+I)
  • Underline (Ctrl+U)
  • Strikethrough (~~text~~ / Ctrl+Shift+X)
  • Headings (# H1 through ###### H6)
  • Blockquotes (> quote)
  • Unordered lists (- item)
  • Ordered lists (1. item)
  • Code blocks (triple backtick)
  • Inline code (single backtick)
  • Tables
  • Links — insert, edit, and remove with URL input
  • Dividers (horizontal rules)
  • Text alignment (left, center, right, justify)
  • Line breaks

Checklists / Task Lists

  • Toggle between regular note and checklist mode
  • Add, remove, reorder checklist items
  • Check/uncheck items with checkboxes
  • Checked items get strikethrough styling
  • Enter key adds new item, Backspace removes empty items

Image Attachments

  • Upload images via file picker or drag-and-drop
  • Supports JPEG, PNG, GIF, WebP, SVG
  • Max file size: 10MB
  • Client-side optimization: images resized to fit 1920×1920, compressed to WebP (~80% quality), transparent PNGs preserved
  • Auto-generated thumbnails: 200×200 WebP at 60% quality for fast card previews
  • Thumbnail strip on note cards (up to 3 images, "+N" badge for more)
  • Full-size images in editor, thumbnails on cards (&thumb=1)
  • Offline support: optimized blobs stored in IndexedDB, displayed via blob URLs, auto-synced on reconnect
  • Pending upload indicator on offline-queued images
  • Service worker CacheFirst caching for previously-viewed images
  • Remove attachments from editor

Tag Organization

  • Inline #hashtag extraction from note content
  • Tags automatically parsed from title and content
  • Filter notes by tag (sidebar + tag chips)
  • Tags are case-insensitive and deduplicated
  • Tags inside code blocks and URLs are ignored

Color-Coded Notes

12 colors matching Google Keep's palette:

  • Default, Coral, Peach, Sand, Mint, Sage
  • Fog, Storm, Dusk, Blossom, Clay, Chalk
  • Colors adapt to note theme

Pin Notes

  • Pin important notes to always appear at top
  • Pinned section separated from unpinned notes
  • Toggle pin from note card hover actions

Archive

  • Archive notes to declutter main view
  • Archived notes accessible from sidebar
  • Unarchive to restore to main view

Trash

  • Soft delete moves notes to trash
  • Trash view accessible from sidebar
  • Restore notes from trash
  • Permanently delete from trash

Full-Text Search

  • Search across note titles, content, and tags
  • Real-time search results as you type
  • Clear search to restore original view
  • Case-insensitive matching

Single-User Auth

  • First-run setup: create password (min 8 chars)
  • Argon2 password hashing (industry standard)
  • Session-based auth with 30-day expiry
  • All routes protected except /login and /setup
  • Logout clears session

PWA / Offline-First

  • Installable as standalone app
  • Web app manifest with icons
  • Service worker for asset caching (CacheFirst for attachments, NetworkFirst for API)
  • IndexedDB for local data storage (notes + pending attachments)
  • Background sync every 30 seconds (notes + offline attachments)
  • LWW conflict resolution for multi-device use
  • Sync status indicator (synced/syncing/offline/error)

MCP Server (Model Context Protocol)

  • Built-in MCP endpoint at POST /api/mcp (Streamable HTTP transport)
  • 14 tools: list, get, create, update, trash, restore, archive, unarchive, delete, search notes; list tags; pin, reorder notes; upload images
  • API key authentication (Bearer token)
  • Compatible with Claude Code, Claude Desktop, and other MCP clients
  • Stateful sessions with automatic cleanup

API Key Management

  • Generate API keys from the Settings page
  • Keys use crumbs_ prefix for easy identification
  • SHA-256 hashed storage (keys shown once at creation)
  • Track last-used timestamps
  • Revoke keys with confirmation dialog
  • MCP client config example shown in Settings

Docker Deployment

  • Multi-stage Dockerfile (build + slim runtime)
  • docker-compose.yml with persistent volume
  • Health check endpoint
  • Runs as non-root user
  • Configurable via environment variables
View Git Blame Copy Permalink