diff --git a/README.md b/README.md index b633524..3bf17a7 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,41 @@ NoteDiscovery is a **lightweight, self-hosted note-taking application** that put - ๐Ÿ•ธ๏ธ **Graph View** - Interactive visualization of connected notes - โญ **Favorites** - Star your most-used notes for instant access - ๐Ÿ“‘ **Outline Panel** - Navigate headings with click-to-jump TOC +- ๐Ÿค– **AI Assistant Ready** - MCP integration for Claude, Cursor & more + +## ๐Ÿค– AI-Powered Note Management + +

+ MCP Compatible + Works with Claude + Works with Cursor +

+ +NoteDiscovery includes a built-in **Model Context Protocol (MCP)** server, letting AI assistants directly interact with your notes: + +| What AI Can Do | Example | +|----------------|---------| +| ๐Ÿ” **Search & Discover** | *"Find all my notes about Docker deployment"* | +| ๐Ÿ“ **Create & Edit** | *"Create a meeting notes template for tomorrow"* | +| ๐Ÿ“ **Organize** | *"Move all project notes to the archive folder"* | +| ๐Ÿท๏ธ **Tag & Categorize** | *"List all notes tagged with #urgent"* | +| ๐Ÿ“Š **Explore Connections** | *"Show me the knowledge graph of my notes"* | +| โœ๏ธ **Append Ideas** | *"Add this thought to my daily journal"* | + +**One-line setup** for Cursor, Claude Desktop, and other MCP-compatible tools: + +```json +{ + "mcpServers": { + "notediscovery": { + "command": "docker", + "args": ["run", "--rm", "-i", "-e", "NOTEDISCOVERY_URL=http://host.docker.internal:8000", "ghcr.io/gamosoft/notediscovery:latest", "python", "-m", "mcp_server"] + } + } +} +``` + +> ๐Ÿ’ก **See [MCP.md](documentation/MCP.md)** for complete setup instructions and all available tools. ## ๐Ÿš€ Quick Start @@ -211,6 +246,7 @@ Want to learn more? - ๐Ÿ“Š **[MERMAID.md](documentation/MERMAID.md)** - Diagram creation with Mermaid (flowcharts, sequence diagrams, and more) - ๐Ÿ”Œ **[PLUGINS.md](documentation/PLUGINS.md)** - Plugin system and available plugins - ๐ŸŒ **[API.md](documentation/API.md)** - REST API documentation and examples +- ๐Ÿค– **[MCP.md](documentation/MCP.md)** - AI assistant integration (Claude, Cursor, and more) - ๐Ÿ” **[AUTHENTICATION.md](documentation/AUTHENTICATION.md)** - Enable password protection for your instance - ๐Ÿ”ง **[ENVIRONMENT_VARIABLES.md](documentation/ENVIRONMENT_VARIABLES.md)** - Configure settings via environment variables diff --git a/docs/index.html b/docs/index.html index 5b0ffef..cb47d41 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,8 +7,8 @@ NoteDiscovery - Your Self-Hosted Knowledge Base - - + + @@ -17,7 +17,7 @@ - + @@ -28,7 +28,7 @@ - + @@ -689,7 +689,7 @@

Take Control of Your Notes

-

A lightweight, privacy-focused note-taking application with powerful features: LaTeX math equations, Mermaid diagrams, smart tags, custom templates, code highlighting, and more. Write, organize, and discover your notes with a beautiful, modern interfaceโ€”all running on your own server.

+

A lightweight, privacy-focused note-taking application with powerful features: AI assistant integration (MCP), LaTeX math equations, Mermaid diagrams, smart tags, custom templates, code highlighting, and more. Write and organize your notes with a beautiful, modern interface all running on your own server.

Try Live Demo Get Started on GitHub โ†’ @@ -840,6 +840,12 @@

No subscriptions, no hidden fees. Free and open source forever.

+
+
๐Ÿค–
+

AI Assistant Ready

+

MCP integration lets Claude, Cursor & other AI tools search, create, and organize your notes.

+
+
๐Ÿงฎ

LaTeX Math

@@ -912,11 +918,6 @@

Progressive Web App (PWA) - install on desktop or mobile for a native experience.

-
-
๐ŸŒ
-

Multi-Language

-

Built-in translations for English, Spanish, German, and French. Easy to add more.

-
@@ -1009,6 +1010,14 @@ [[Link notes]] Obsidian-style
+ +
+ ๐ŸŒ +
+ Multi-Language + English, Spanish, German, French +
+
@@ -1182,11 +1191,11 @@ "@context": "https://schema.org", "@type": "SoftwareApplication", "name": "NoteDiscovery", - "description": "A lightweight, Obsidian and Evernote alternative, privacy-focused Markdown note-taking application with LaTeX math, Mermaid diagrams, and code highlighting. Self-hosted, free, and open source.", + "description": "A lightweight, AI-powered Markdown note-taking application with MCP integration for Claude, Cursor and other AI assistants. Features LaTeX math, Mermaid diagrams, graph view, and code highlighting. Self-hosted Obsidian and Evernote alternative. Free and open source.", "url": "https://www.notediscovery.com", "applicationCategory": "ProductivityApplication", "operatingSystem": "Linux, Windows, macOS", - "featureList": "Markdown editor, Wikilinks, Graph view, LaTeX math equations, Mermaid diagrams, Code syntax highlighting, Dark mode, Plugin system, Internal links, Properties panel, HTML export, Full-text search, Self-hosted, Obsidian, Evernote, Notion, Onenote, Second brain", + "featureList": "AI assistant integration, MCP (Model Context Protocol), Claude integration, Cursor integration, Markdown editor, Wikilinks, Graph view, LaTeX math equations, Mermaid diagrams, Code syntax highlighting, Dark mode, Plugin system, Internal links, Properties panel, HTML export, Full-text search, Self-hosted, Obsidian alternative, Evernote alternative, Notion alternative, Second brain, AI-powered notes", "offers": { "@type": "Offer", "price": "0",